#%RAML 0.8 title: Person API baseUri: "https://apistg.us1.covisint.io/person/v3" protocols: [HTTPS] schemas: - resourceReference: | { "id" : "http://api.covisint.com/schema/resourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing links", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } } , "required":[ "id" ] } - namedResourceReference: | { "id" : "http://api.covisint.com/schema/namedScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the basic resource reference and adds internationalized name and description.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" }, "properties" : { "name" : { "description": "Internationalized resource name.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized resource description.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } } - resource: | { "id" : "http://api.covisint.com/schema/resource", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resource", "type" : "object", "description" : "A basic resource.", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - resourceV2: | { "id" : "http://api.covisint.com/schema/resourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Core schema", "definitions" : { "resource" : { "id" : "resourceV2", "type" : "object", "description" : "A basic resource (version V2).", "properties" : { "id" : { "type" : "string", "maxLength" : 64, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true } } , "required":[ "id", "creator", "creatorAppId", "creation" ] } } } - realmScopedResource: | { "id" : "http://api.covisint.com/schema/realmScopedResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Expands on the base resource and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resource#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - realmScopedResourceV2: | { "id" : "http://api.covisint.com/schema/realmScopedResourceV2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A realm scoped resource (version V2). Expands on the base resource (version V2) and adds a realm attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/resourceV2#" }, "properties" : { "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-realm header.", "readonly": true } } , "required":[ "realm" ] } - errorResponseSchema: | { "id" : "http://api.covisint.com/schema/errorResponseSchema", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Representation of an HTTP 4xx/5xx error response.", "properties" : { "status" : { "type" : "number", "minimum" : 400, "maximum" : 599, "description" : "The HTTP status code." }, "apiMessage" : { "type" : "string", "description" : "A helpful, human-readable description of the error, useful for basic diagnostics." }, "apiStatusCode" : { "type" : "string", "description" : "The API-specific status code." } } , "required":[ "status" ] } - serviceCode: | { "id" : "http://api.covisint.com/schema/serviceCodes", "$schema" : "http://json-schema.org/draft-04/schema", "type": "object", "description": "The site/service/location codes granted along with a service.", "properties": { "code": { "type": "string", "maxLength": 200, "description": "The code value." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The associated business unit." } } , "required":[ "code", "codeKind" ] } - serviceCodes: | { "type" : "array", "description" : "The site/service/location codes granted along with the service, if any.", "items" : { "$ref" : "http://api.covisint.com/schema/serviceCode#"}, "required": false } - address: | { "id" : "http://api.covisint.com/idm/schema/address", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type" : "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } - phone: | { "id" : "http://api.covisint.com/idm/schema/phone", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } - internationalString: | { "id": "http://api.covisint.com/idm/schema/internationalString", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "An internationalized string value, supporting one or more language translations.", "minItems": 1, "items": { "type": "object", "properties": { "lang": { "type": "string", "maxLength": 10, "description": "The language or locale in which the text is written." }, "text": { "type": "string", "maxLength": 2000, "description": "The internationalized text value." } } } } - tags: | { "id": "http://api.covisint.com/idm/schema/tag", "$schema": "http://json-schema.org/draft-04/schema", "type": "array", "description" : "The tags associated with a resource. This array is read-only, and may be modified on the resource endpoint with the appropriate tagging APIs.", "minItems": 1, "items": { "type": "object", "properties": { "tagName": { "type": "string", "description": "The tag associated with a resource." } } } } - baseDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base rule definition(version V1). Expands on the base resource (version V2) and adds a realm attribute.", "extends": { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties": { "name": { "description": "The application name (internationalized).", "$ref": "http://api.covisint.com/schema/internationalString#" }, "description": { "description": "The application description (internationalized).", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "properties":{ "type":"array", "description":"Properties used by the implementation.", "minItems":0, "items":[ { "anyOf": [ { "type": "string", "description": "The name of the property." }, { "type": "string", "description": "The value of the property." } ] } ] } , "required":[ "items" ] } , "required":[ "name" ] } - baseActionDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseActionDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action action definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of action definition.", "enum": [ "SEND_APPLICATION_NOTIFICATION", "SEND_COMMAND", "SEND_NOTIFICATION" ], "required": true } } , "required":[ "type" ] } - baseTriggerDefinitionResource: | { "id" : "http://api.covisint.com/schema/baseTriggerDefinitionResource", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A base action trigger definition. Expands on the base definition resource ", "extends": { "$ref" : "http://api.covisint.com/schema/baseDefinitionResource#" }, "properties": { "type": { "description": "Type of trigger definition.", "enum": [ "DEVICE_SEND_EVENT", "DEVICE_LIFECYCLE_STATE_CHANGE", "DEVICE_OPERATIONAL_STATE_CHANGE" ] } } , "required":[ "type" ] } - dataType: | { "id" : "http://api.covisint.com/schema/dataType", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Data type enum.", "enum":[ "string", "integer", "bool", "decimal" ] } - attribute: | { "id" : "http://api.covisint.com/schema/attribute", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "An attribute.", "properties" : { "oneOf" : [ { "attributeTypeId" : { "type" : "string", "description" : "The attribute type id." } }, { "attributeType" : { "description" : "The full attribute type definition.", "$ref" : "http://api.covisint.com/schema/attributeType#" } } ], "value" : { "type" : "any", "description" : "The attribute value." } } , "required":[ "attributeTypeId" ] } - attributes: | { "id" : "http://api.covisint.com/schema/attributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Collection of attributes.", "items" : { "$ref" : "http://api.covisint.com/schema/attribute#" } } - expression: | { "id" : "http://api.covisint.com/schema/expression#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "The DSL for defining conditional expressions.", "oneOf" : [ { "type" : "object", "properties" : { "any" : { "type" : "array", "description" : "An aggregate expression representing an 'any' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "properties" : { "all" : { "type" : "array", "description" : "An aggregate expression representing an 'all' condition.", "items" : { "$ref" : "http://api.covisint.com/schema/expression#" } } } }, { "type" : "object", "description" : "A simple leaf-node expression. The format of this expression is: '(f:, v:())'. The supported expressions are: equal, notEqual, startsWith, endsWith, matches, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual. The field name can be a simple field name i.e. 'id' or hierarchical field name using dot-notation like 'resource.id' / 'resource.tag[0]' . The value corresponding to the field name provided should always be a simple data type and cannot be an array or an object.", "properties" : { "expr" : { "type" : "string" } } , "required":[ "expr" ] } ] } - person: | { "id" : "http://api.covisint.com/idm/schema/person/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 100 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but will be ignore on POST requests." }, "status" : { "enum" : [ "pending", "rejected", "active", "suspended", "inactive", "locked", "expired", "unactivated", "preterminated" ], "description" : "The person's account status, which is read-only. Statuses can be changed through tasks." }, "name" : { "type" : "object", "description" : "A container for the person's name elements", "properties" : { "prefix" : { "type" : "string", "description" : "The prefix to the person's name. For example: Mr., Mrs., Rev.", "maxLength" : 100 }, "given" : { "type" : "string", "description" : "The person's given (first) name.", "maxLength" : 150 }, "middle": { "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "surname": { "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "suffix" : { "type" : "string", "description" : "The person's name suffix. For example: Jr., Ph.D., M.D.", "maxLength" : 50 } }, "required" : [ "given", "surname"] }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username of the person." }, "authDomain" : { "type" : "string", "description" : "The person's authentication domain.", "maxLength" : 50 }, "lastlogindate" : { "type" : "number", "description" : "The person's last Login Date.", "maxLength" : 50 }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 0, "items" : { "ref" : "http://api.covisint.com/idm/schema//address#" } }, "language" : { "type" : "string", "maxLength" : 2, "description" : "The person's preferred language, in ISO639-1 format." }, "timezone" : { "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/phone#" } }, "title" : { "type" : "string", "maxLength" : 60, "description" : "The person's job title" }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "organization" : { "description" : "The organization to which the person belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." }, "externalId" : { "type" : "string", "maxLength" : 100, "description" : "The person's external Id." }, "attributes":{ "type": "array", "minItems": 0, "description": "The attribute templates for persons.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } }, "preferences" : { "type" : "array", "description" : "A container for the person's notification preference(s).", "minItems" : 0, "items" : { "type" : "object", "description" : "A container for notification preference details.", "properties" : { "eventId" : { "type" : "string","maxLength" : 100, "description" : "The notification event id." }, "emailSubscription " : { "type" : "string", "description" : "The email subscription.", "default" : "true" }, "smsSubscription " : { "type" : "string", "description" : "The email subscription.", "default" : "true" } }, "required" : [ "eventId", "emailSubscription", "smsSubscription" ] } }, "required" : [ "language", "timezone","email","organization"] } - personMyProfile: | { "id" : "http://api.covisint.com/idm/schema/person/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 100 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but will be ignore on POST requests." }, "status" : { "enum" : [ "active" ], "description" : "The person's account status, which is read-only. Statuses can be changed through tasks." }, "name" : { "type" : "object", "description" : "A container for the person's name elements", "properties" : { "prefix" : { "type" : "string", "description" : "The prefix to the person's name. For example: Mr., Mrs., Rev.", "maxLength" : 100 }, "given" : { "type" : "string", "description" : "The person's given (first) name.", "maxLength" : 150 }, "middle": { "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "surname": { "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "suffix" : { "type" : "string", "description" : "The person's name suffix. For example: Jr., Ph.D., M.D.", "maxLength" : 50 } }, "required" : [ "given", "surname"] }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username of the person." }, "authDomain" : { "type" : "string", "description" : "The person's authentication domain.", "maxLength" : 50 }, "lastlogindate" : { "type" : "number", "description" : "The person's last Login Date.", "maxLength" : 50 }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 0, "items" : { "ref" : "http://api.covisint.com/idm/schema//address#" } }, "language" : { "type" : "string", "maxLength" : 2, "description" : "The person's preferred language, in ISO639-1 format." }, "timezone" : { "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/phone#" } }, "title" : { "type" : "string", "maxLength" : 60, "description" : "The person's job title" }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "organization" : { "description" : "The organization to which the person belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." }, "attributes":{ "type": "array", "minItems": 0, "description": "The attribute templates for persons.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } }, "questions": { "type" : "array", "description": "The security questions chosen for this particular account. Visible only if media type has includeSecurityAccount=true", "minItems": 1, "items": { "type": "object", "properties": { "question": { "description": "The selected question.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "answer" : { "type" : "string", "maxLength" : 255, "description" : "The actual answer text, in the supplier's preferred locale. Required only when creating or updating the security question account." }, "index" : { "type" : "number", "description" : "The logical order in which this question is to be viewed with respect to other questions used by this account. If provided, should be for all questions in a sequence starting with 1.", "minValue" : 1 } }, "required":["question"] } }, "servicePackageGrants": { "type" : "array", "description": "The package grants for person. Visible only if media type has includePackageGrants=true", "minItems": 1, "items": { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "active" ], "description" : "The status of the grant. Only required when grant is retrieved. Not required when grant is created." }, "grantee": { "description": "The subject owning the grant", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The granted package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackageResource": { "description": "The password account associated with the person.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "owningOrganization": { "description": "The organization that owns this package.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "parent": { "description": "The parent package. Used to create a package hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "codeRestrictions": { "type": "object", "description": "Indicates whether site/location code(s) must be specified when requesting/granting this package.", "properties": { "requestorType": { "type": "string", "enum": [ "person", "organization" ] }, "restriction": { "type": "string", "enum": [ "site", "location" ] } } }, "termsAndConditions": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "person", "organization" ], "description": "The target entity of the terms and conditions." }, "tacId": { "type": "string", "description": "The identifier of the T&C record.", "maxLength": 15 } } } }, "protected": { "type": "boolean", "description": "Indicates whether this package is synced back to cleartrust entitlements server, and therefore protected by the ct web agent.", "default" : false }, "requestable": { "type": "boolean", "description": "Indicates whether this package may be requested by persons or organizations.", "default" : false }, "grantable": { "type": "boolean", "description": "Indicates whether this package may be granted to persons or organizations.", "default" : true }, "displayable": { "type": "boolean", "description": "Indicates whether this package may be displayed or should be suppressed in UIs.", "default" : true }, "requestReasonRequired": { "type": "boolean", "description": "Indicates whether package requests must be accompanied by a reason supplied by the requestor.", "default" : false }, "name" : { "description": "Internationalized package names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized package descriptions.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "requiredApprovals" : { "type" : "array", "description": "List of approval actors required to make decisions on package requests before it can be granted. Defaults to organizationAdmin if no values are provided.", "minItems": 0, "items": { "enum" : [ "organizationAdmin", "applicationAdmin", "provisioningAdmin" ] }, "default" : "organizationAdmin" } } } } } } }, "required" : [ "language", "timezone","email","organization"] } - passwordChangesHistory: | { "id" : "http://api.covisint.com/schema/passwordChangesHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an password changes history.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "eventType": { "enum" : [ "CHANGE_PASSWORD", "RESET_PASSWORD", "SPECIFY_PASSWORD"], "description": "The event type of the person." }, "passwordUpdatedUserId": { "type" : "string", "description": "The password updated user id." }, "reason": { "type" : "string", "description": "The reason for password updated." }, "userId": { "type" : "string", "description": "The person's registration id." } } } - privileges: | { "id" : "http://api.covisint.com/schema/privileges#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Schema representing an privilege resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "privilegeId" : { "description" : "The id of the privilege.", "type" : "string" }, "privilegeName" : { "description" : "The name of the privilge.", "type" : "string" }, "priivlegeDesc" : { "description" : "The desc of the privilege.", "type" : "string" }, "privilegeGroupId" : { "description" : "The id of the privilege group.", "type" : "string" }, "privilegeGroupName" : { "description" : "The name of the privilge group.", "type" : "string" }, "privilegeGroupDesc" : { "description" : "The desc of the privilege group.", "type" : "string" } } } - roles: | { "id" : "http://api.covisint.com/schema/roles#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description" : "Schema representing an roles resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "roleId" : { "description" : "The id of the role.", "type" : "string" }, "name" : { "description" : "The name of the role.", "type" : "string" }, "externalRoleId" : { "description" : "The id of the role.", "type" : "string" }, "organization":{ "description" : "The organization to which the person belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "privileges":{ "description" : "The list of privileges of the roles.", "$ref": "http://api.covisint.com/schema/privileges#" } } } - personRole: | { "id" : "http://api.covisint.com/schema/personRole#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing a person role resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "userId" : { "description" : "The global covisint user id of the person.", "type" : "string" }, "roles" : { "type" : "array", "description" : "A container for the roles.", "items" : { "$ref" : "http://api.covisint.com/schema/resourceReference#" } } }, "required" : [ "userId", "roles"] } - deletePersonRole: | { "id" : "http://api.covisint.com/schema/personRole#", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing a delete person role resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "userId" : { "description" : "The global covisint user id of the person.", "type" : "string" }, "roleIds" : { "type" : "array", "description" : "A container for the role ids.", "items" : { "type": "integer" } } }, "required" : [ "userId", "roleIds"] } - passwordValidationResponse: | { "id" : "http://api.covisint.com/schema/passwordValidationResponses", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Collection of password validation responses", "type" : "array", "properties" : { "type" : { "type" : "string", "description": "list of status codes to represent the password validation response.", "enum": ["LENGTH","DISALLOWED_CHARACTERS","DISALLOWED_WORDS","HISTORY","CHARACTER_CLASS","LIFETIME"] }, "description" : { "type" : "string", "description": "The description for the password validation status code ." }, "isPassed" : { "type" : "boolean", "description": "It would be true or false basis on whether rule is passed or not." } } } - passwordValidationRequest: | { "id" : "http://api.covisint.com/schema/passwordValidationRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an password resource for user registration.", "properties" : { "password" : { "type" : "string", "description": "The password of the user." }, "organizationId" : { "type" : "string", "description": "The user's organization id." }, "inviteId" : { "type" : "string", "description": "The user's inviteeId." }, "userId" : { "type" : "string", "description": "The user's id of the resource." }, "operations" : { "description": "The operation of resource perform on the password [AUTHENTICATE,PASSWORD_RESET,PASSWORD_SPECIFY,PASSWORD_CHANGE,EXPIRED_PASSWORD_CHANGE]", "type": "array" }, "username" : { "type" : "string", "description" : "The username of the user , to be used for username rule validation" }, "email" : { "type" : "string", "description" : "The email of the user , to be used for email rule validation" } }, "required" : [ "password", "operations"] } - registrationStatus: | { "id" : "http://api.covisint.com/schema/registrationStatus", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing user registration status.", "properties" : { "status" : { "description": "The status of the user.", "enum": ["PENDING","REJECTED","ACTIVE","SUSPENDED","INACTIVE","LOCKED","EXPIRED","UNACTIVATED"] } } } - passwordAccount: | { "id" : "http://api.covisint.com/idm/schema/passwordAccount/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person's password account.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id" : { "description" : "The unique identifier for this resource. This is not required on PUT requests - user supplied value will be ignored." }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but will be ignore on POST requests." }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username on the account. This is typically what the user enters into the login box when authenticating." }, "password" : { "type" : "string", "description" : "The account password. This password, along with username, are the credentials used to authenticate." }, "currentPassword" : { "type" : "string", "description" : "The current password. This password, along with username, are the credentials used to authenticate to change the password, required only for change password." }, "passwordPolicy" : { "description" : "The password policy governing the password.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "authenticationPolicy" : { "description" : "The authentication policy governing the password.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "expiration" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when the password expires." }, "locked" : { "type" : "boolean", "description" : "Whether or not the account is locked." }, "unlockInstant" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when the account will be unlocked. Will be zero if the account is not locked via a time-based mechanism." } }, "required" : [ "username", "password","passwordPolicy","authenticationPolicy"] } - personInvitation: | { "id" : "http://api.covisint.com/schema/personInvitation", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an invitation for a person to register.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignored on POST requests." }, "email" : { "type" : "string", "description": "The email address that is to receive the invitation.", "maxLength": 500 }, "invitor": { "description": "The person that is sending the invitation.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "invitee": { "description": "An unactivated person that is to be used during the registration initiated by this invitation. This is an optional way to prepopulate user attributes at invitation time.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "targetOrganization": { "description": "The organization that the person will join as a result of the registration initiatied by this invitation.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage": { "description": "The service package which are granted to the target organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "subPackages": { "type": "array", "description": "The list of service sub packages which are granted to the target person or organization.", "minItems": 0, "items": {"$ref": "http://api.covisint.com/schema/resourceReference#"} }, "invitationCode" : { "type" : "string", "description": "A system-generated invitation code. This can aid in verification for systems requiring a secured invitation process.", "maxLength": 50 }, "restrictEmail" : { "type" : "boolean", "description": "If restrictEmail is true. During the person registration, it will check for the invite email and person email equall or not " } }, "required" : [ "email", "targetOrganization"] } - personRequest: | { "id" : "http://api.covisint.com/schema/personRegistration", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a registration request of a person.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "registrant": { "description": "The person that is being registered. The person must be in pending status for the request to be valid.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "justification" : { "type" : "string", "description": "The justification for the registration.", "maxLength": 1000 }, "parentRequest": { "description": "The parent request of the person request, it will be read-only. This is only for division request which internally make the user request.", "$ref": "http://api.covisint.com/schema/resourceReference#" } }, "required" : [ "registrant", "justification"] } - personRequestHistory: | { "id" : "http://api.covisint.com/schema/personRequestHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person's request history.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "userId": { "type" : "string", "description": "The person registration id" }, "requestId" : { "type" : "string", "description": "The person request id." }, "requestorUserId": { "type" : "string", "description": "The person requestor user id" }, "actionPerformedUserId": { "type" : "string", "description": "The action perfomed user id" }, "packageName": { "type" : "string", "description": "The user's package name" }, "descisionDate": { "type" : "integer", "description": "The decision date" }, "nPhaseApprovalType": { "type" : "number", "enum" : [ "0", "1", "2", "13"], "description": "The person's NPhaseApprovalType" } }, "required" : [ "userId"] } - personStatusHistory: | { "id" : "http://api.covisint.com/schema/personStatusHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person's status history.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "status": { "type" : "string", "description": "The status of the person" }, "notes" : { "type" : "string", "description": "The notes of the person" }, "systemEventType": { "type" : "string", "description": "The person's system event type" }, "userId": { "type" : "string", "description": "The user's registration id" }, "lastUpdatedPersonUserId": { "type" : "string", "description": "The the last updated person user id" } }, "required" : [ "status", "userId"] } - userInfo: | { "id" : "http://api.covisint.com/idm/userInfo", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a user info as claims.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "sub": { "type" : "string", "description" : "The id of the subject( person)" }, "given_name":{ "type" : "string", "description" : "The person's given (first) name." }, "family_name":{ "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "middle_name":{ "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "zoneinfo":{ "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 0, "items" : { "ref" : "http://api.covisint.com/idm/schema//address#" } }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/phone#" } }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "updated_at" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when this resource was created or updated`" }, "name" : { "type" : "string", "maxLength" : 1000, "description" : "The person's full name." }, "perferredUsername" : { "type" : "string", "maxLength" : 1000, "description" : "The person's login name." }, "language" : { "type" : "string", "maxLength" : 1000, "description" : "The person's preferred language, e.g. en" }, "timeZone" : { "type" : "string", "maxLength" : 1000, "description" : "The person's time zone, e.g. America/New_York" }, "country" : { "type" : "string", "maxLength" : 1000, "description" : "The person's country, e.g. US" }, "remoteId" : { "type" : "string", "maxLength" : 1000, "description" : "The person's external guid." }, "organizationName" : { "type" : "string", "maxLength" : 1000, "description" : "The person's global organization name." }, "remoteOrganizationId" : { "type" : "string", "maxLength" : 1000, "description" : "The person organization external organization code." } }, "required" : [ "sub"] } - personPasswordAccount: | { "id" : "http://api.covisint.com/schema/personPasswordAccount", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a registration request of a person contains person and password account.", "properties" : { "person" : { "description": "The person to be created.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "status" : { "enum" : [ "pending", "rejected", "active", "suspended", "inactive", "locked", "expired", "unactivated", "preterminated" ], "description" : "The person's account status, which is read-only. Statuses can be changed through tasks." }, "name" : { "type" : "object", "description" : "A container for the person's name elements", "properties" : { "prefix" : { "type" : "string", "description" : "The prefix to the person's name. For example: Mr., Mrs., Rev.", "maxLength" : 100 }, "given" : { "type" : "string", "description" : "The person's given (first) name.", "maxLength" : 150 }, "middle": { "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "surname": { "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "suffix" : { "type" : "string", "description" : "The person's name suffix. For example: Jr., Ph.D., M.D.", "maxLength" : 50 } }, "required" : [ "given", "surname"] }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 1, "items" : { "type" : "object", "description" : "A container for the subject's address elements.", "properties" : { "streets" : { "type" : "array", "description" : "An array of address streets (i.e. address line 1, 2, 3).", "minItems" : 0, "items" : { "type": "string", "maxLength" : 255 } }, "city" : { "type" : "string", "maxLength" : 60, "description" : "The city name." }, "state" : { "type" : "string", "maxLength" : 60, "description" : "The state/province name or code." }, "postal" : { "type" : "string", "maxLength" : 10, "description" : "The postal or zip code." }, "country" : { "type" : "string", "minLength" : 2, "maxLength" : 3, "description" : "The ISO country code. http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2"} } } }, "language" : { "type" : "string", "maxLength" : 2, "description" : "The person's preferred language, in ISO639-1 format." }, "timezone" : { "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "type" : "object", "description" : "A container for phone number details.", "properties" : { "number" : { "type" : "string","maxLength" : 100, "description" : "The phone number." }, "type" : { "enum" : [ "main", "mobile", "fax" ], "description" : "The phone number type." } }, "required" : [ "type" ] } }, "title" : { "type" : "string", "maxLength" : 60, "description" : "The person's job title" }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "organization" :{ "description" : "The organization to which the person belongs.", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } }, "required" : [ "id"] }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." } }, "required" : [ "id", "creator","creatorAppId","creation","language","timezone","email"] }, "passwordAccount" : { "description": "The password account associated with the person.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but should not be supplied for POST requests." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username on the account. This is typically what the user enters into the login box when authenticating." }, "password" : { "type" : "string", "description" : "The account password. This password, along with username, are the credentials used to authenticate." }, "passwordPolicy" : { "description" : "The organization to which the person belongs.", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } }, "required" : [ "id"] }, "authenticationPolicy" :{ "description" : "The organization to which the person belongs.", "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the resource." }, "type" : { "type" : "string", "description" : "The type of the resource." }, "realm" : { "type" : "string", "description" : "The realm of the resource." } }, "required" : [ "id"] }, "expiration" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when the password expires." }, "locked" : { "type" : "boolean", "description" : "Whether or not the account is locked." }, "unlockInstant" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when the account will be unlocked. Will be zero if the account is not locked via a time-based mechanism." } }, "required" : [ "id", "creator","creatorAppId","creation","username","password"] }, "securityQuestionAccount" : { "description": "The security questions associated with the person.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "description" : "The unique identifier for this resource." }, "version": { "type" : "string", "description" : "The current version for this security question." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "questions" : { "type" : "array", "description": "The security questions chosen for this particular account.", "minItems": 0, "items": { "type": "object", "properties": { "question": { "description": "The selected question.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "answer" : { "type" : "string", "maxLength" : 255, "description" : "The actual answer text, in the supplier's preferred locale. Required only when creating or updating the security question account." }, "index" : { "type" : "number", "description" : "The logical order in which this question is to be viewed with respect to other questions used by this account. If provided, should be for all questions in a sequence starting with 1.", "minValue" : 1 } }, "required" : [ "question"] } } }, "required" : [ "id", "creator","creatorAppId","creation"] }, "attributeTemplate" : { "description": "The extended attributes associated with the person.", "type" : "object", "properties" : { "id" : { "type" : "string", "maxLength" : 100, "description" : "The unique identifier for the attribute template." }, "version": { "type" : "string", "description" : "The current version for the attribute template." }, "creator" : { "type" : "string", "maxLength" : 64, "description" : "The creator of this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor header.", "readonly": true }, "creatorAppId" : { "type" : "string", "maxLength" : 64, "description" : "The id of the application used to create this resource. This read-only field is ignored by the server, and is overlayed with the value supplied in the x-requestor-app header.", "readonly": true }, "creation" : { "type" : "number", "minimum" : 0, "maximum" : 9223372036854775807, "description" : "This read only property is ignored by the server and the system will overlay with the time, in milliseconds since the epoch, when this resource was created.", "readonly": true }, "realm" : { "type" : "string", "maxLength" : 25, "pattern" : "^[A-Za-z0-9]{2,25}$", "description" : "The realm in which this resource is being created. This is mandatory if x-realm header is NOT available" }, "attributes":{ "type": "array", "minItems": 1, "description": "The extended attributes for person.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } }, "required" : [ "id", "creator","creatorAppId","creation"] }, "inviteId":{ "type": "string", "description": "The invite id for person." }, "pin":{ "type": "string", "description": "The invitation pin for person. Required in case of secured invitation" } } } - attributeTemplate: | { "id" : "http://api.covisint.com/schema/attributeTemplate#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an attributeTemplates.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "attributes":{ "type": "array", "minItems": 1, "description": "The extended attributes for person.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "The id of the extended attribute." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The value of the extended attribute." } } } } } } - personDetailStatusHistory: | { "id" : "http://api.covisint.com/schema/personStatusHistory", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a person's status history.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id": { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. Exists once the resource has been saved. This is mandatory for PUT requests, but is not required and will be ignore on POST requests." }, "status": { "type" : "string", "description": "The status of the person" }, "notes" : { "type" : "string", "description": "The notes of the person" }, "systemEventType": { "type" : "string", "description": "The person's system event type" }, "userId": { "type" : "string", "description": "The user's registration id" }, "name" : { "type" : "object", "description" : "A container for the person's name elements", "properties" : { "prefix" : { "type" : "string", "description" : "The prefix to the person's name. For example: Mr., Mrs., Rev.", "maxLength" : 100 }, "given" : { "type" : "string", "description" : "The person's given (first) name.", "maxLength" : 150 }, "middle": { "type" : "string", "description" : "The person's middle name(s).", "maxLength" : 60 }, "surname": { "type" : "string", "description" : "The person's surname or family name.", "maxLength" : 150 }, "suffix" : { "type" : "string", "description" : "The person's name suffix. For example: Jr., Ph.D., M.D.", "maxLength" : 50 } }, "required" : [ "given", "surname"] }, "username" : { "type" : "string", "maxLength" : 100, "description" : "The username of the person." }, "addresses" : { "type" : "array", "description" : "A container for the person's addresses.", "minItems" : 0, "items" : { "ref" : "http://api.covisint.com/idm/schema//address#" } }, "language" : { "type" : "string", "maxLength" : 2, "description" : "The person's preferred language, in ISO639-1 format." }, "timezone" : { "type" : "string", "description" : "The person's preferred timezone. See http://docs.oracle.com/javase/7/docs/api/java/util/TimeZone.html#getAvailableIDs()" }, "phones" : { "type" : "array", "description" : "A container for the person's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/phone#" } }, "title" : { "type" : "string", "maxLength" : 60, "description" : "The person's job title" }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The person's email address." }, "organization" : { "description" : "The organization to which the person belongs.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." }, "lastUpdatedDate": { "type" : "string", "description": "The last updated date" }, "lastUpdatedPersonUserId": { "type" : "string", "description": "The the last updated person user id" } }, "required" : [ "status", "userId","language","timezone","email","organization","currency","lastUpdatedDate"] } - PasswordAuthenticationRequest: | { "id" : "http://api.covisint.com/schema/PasswordAuthenticationRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a passwordauthentication request resource.", "properties" : { "instant" : { "type" : "number", "description" : "The time, in milliseconds since the epoch, when the authentication request is being made. if not provided, default current time in milliseconds will be set." }, "subject": { "type": "string", "description": "The subject for which this request is being made. It should be username." }, "subjectType":{ "type": "string", "enum": ["LOGIN_ID"], "description": "The type of the subject." }, "password": { "type": "string", "description": "The password for the subject to validate." }, "service": { "type": "string", "description": "The caller service description for the request.", "maxLength" : 128 }, "subjectInet": { "type": "string", "description": "The IP address of the caller service.", "maxLength" : 64 } }, "required" : [ "subject", "password","service","subjectInet"] } - generatelinkrequest: | { "id" : "http://api.covisint.com/schema/generatelinkrequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing generate link request.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "subject": { "type": "string", "description": "The subject for which this request is being made. It can be either cuid or username." }, "subjectType":{ "type": "string", "enum": [ "CUID", "LOGIN_ID"], "description": "The type of the subject.", "default": "CUID" } }, "required" : [ "subject"] } - generatelinkresponse: | { "id" : "http://api.covisint.com/schema/generatelinkresponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing generate link response.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "secret" : { "type" : "string", "description": "The secret string for generatelinkresponse." } }, "required" : [ "secret"] } - validatelinkrequest: | { "id" : "http://api.covisint.com/schema/validatelinkrequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing validate link request.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "secret": { "type" : "string", "description": "The secret string for validatelinkrequest." } }, "required" : [ "secret"] } - validatelinkresponse: | { "id" : "http://api.covisint.com/schema/validatelinkresponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing validate link request.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "secret": { "type" : "string", "description": "The secret string for validatelinkrsponse." } }, "required" : [ "secret"] } - service.codes: | { "id" : "http://api.covisint.com/schema/validatelinkresponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing validate link request.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "secret": { "type" : "string", "description": "The secret string for validatelinkrsponse." } }, "required" : [ "secret"] } - jwtTokenResponse: | { "id" : "http://api.covisint.com/schema/jwtTokenResponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing JWT token response.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "jwt": { "type" : "string", "description": "The JWT token for subject." } } } - personImpersonationRequest: | { "id" : "http://api.covisint.com/schema/personImpersonationRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing Request for JWT based on external attribute.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "attributeName": { "type" : "string", "description": "The attribute name for subject." }, "attributeValue":{ "type" : "string", "description": "The attribute value for subject." } } } - userNotificationPerferences: | { "id" : "http://api.covisint.com/schema/userNotificationPerferences", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing user notification perferences.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "userId": { "type" : "string", "description": "The person's registration id." }, "preferences" : { "type" : "array", "description" : "A container for the person's notification preference(s).", "minItems" : 0, "items" : { "type" : "object", "description" : "A container for notification preference details.", "properties" : { "eventId" : { "type" : "string","maxLength" : 100, "description" : "The notification event id." }, "emailSubscription " : { "type" : "string", "description" : "The email subscription.", "default" : "true" }, "smsSubscription " : { "type" : "string", "description" : "The email subscription.", "default" : "true" } }, "required" : [ "eventId", "emailSubscription", "smsSubscription" ] } } } } traits: - secured: displayName: secured - unsecured: displayName: unsecured - getResponse: displayName: getResponse - getSearchResponse: displayName: getSearchResponse - postResponse: displayName: postResponse - deleteResponse: displayName: deleteResponse - putResponse: displayName: putResponse - putResponseV2: displayName: putResponseV2 - putCreateResponse: displayName: putCreateResponse - taskResponse: displayName: taskResponse - pagableRequest: displayName: pagableRequest - taggable: displayName: taggable - sortable: displayName: sortable - searchable: displayName: searchable /persons: is: [secured] get: description: "Searches person resources according to the filter criteria provided.[Since:1.0][flow-name:person-search-persons][policy:RETRIEVE_PERSONS]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json;includedivision=true;includelastlogindate=true;includeNotificationPrefs=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve persons for a supplied person identifier. Multiple values may be provided, in which case all found ids will be returned. type: string required: false repeat: false organization.id: description: Retrieve all persons belonging to this organization. type: string required: false repeat: false username: description: Retrieve all persons matching this username. Wildcard search supported. type: string required: false repeat: false authnDomain: description: Constraint the search to persons with accounts in the given authentication domain (optional parameter). This value must only be provided with the username parameter. type: string required: false repeat: false name.given: description: Retrieve persons for a supplied given name. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name.surname: description: Retrieve persons for a supplied surname. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false email: description: Retrieve persons for a supplied email address. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false securityadmin: description: Retrieve security admins for a supplied organization if organization is provided, else it is read-only, Multiple parameters are supported and the search results will be a union. type: boolean required: false repeat: false roleId: description: Retrieve users for the supplied role id, and under requestor's organization hierarchy(if roleId is provided). Multiple parameters are supported and the search result will be a union. type: string required: false repeat: false roleName: description: Retrieve users for the supplied role name, and under requestor's organization hierarchy(if roleName is provided). Multiple parameters are supported and the search result will be a union. type: string required: false repeat: false fullName: description: Retrieve users for the supplied name (wilecard search), and under requestor's organization hierarchy(if fullName is provided). Multiple parameters are not allowed. type: string required: false repeat: false isRolesGranted: description: The flag to notify to return either granted or not granted users by role, required only if roleId or roleName is provided. By default value is false. type: string required: false repeat: false attributes.name: description: Retrieve users for the supplied attributes name. Wildcard search supported and Multiple parameters are allowed. type: string required: false repeat: false attributes.value: description: Retrieve users for the supplied attributes.value and attributes name. Wildcard search supported and Multiple parameters are not allowed. type: string required: false repeat: false status: description: Retrieve all persons with the given status. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+creation, "-creation", +activatedDate, "-activatedDate", +name.given, "-name.given", +name.surname, "-name.surname"] search_text: description: Text will be searched (wildcard search replaced with % from *) in corresponding parameters(firstname,lastname,username,email) with OR conditions in search_in key and under requestor's organization or below hierarchy (if organization.id and filterByHierarchy=true are available). Multiple parameters are not allowed. type: string required: false repeat: false search_in: description: If Text is provided in search_text key then wild card search will be with all parameters(firstname,lastname,username,email), provided in search_in key (OR conditions). type: string required: false repeat: false filterByHierarchy: description: If filterByHierarchy=true then Retrieve all persons searched under requestor's organization and below hierarchy. organization.id must be part of query parameter. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" responses: "200": description: All matching person resources were successfully retrieved, if organization is provided and the securityadmin flag is provided, then return the persons which are security admins for the organizations. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invalid.searchParams - Searching for persons across different realms is not allowed + person.status.value.invalid - Searching for persons with status value is not valid + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] post: description: "Creates a new person in unactivated status. [Since:1.0][flow-name:person-create-person][policy:CREATE_PERSONS]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.v1+json: schema: person responses: "201": description: A new person was created in unactivated status and is returned in the response body. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + user:request:invalid:phone:type - Unsupported Phone type: {phoneType(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + person.invalid.emailIdFormat - Invalid email id format {emailId} + person.addresses.country - Invalid country code -{country} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/activate/generatelink: description: "collection endpoint for generating link to send email to activate user account [Since:3.0]" post: description: "collection endpoint for generating link to send email to reset user password. [flow-name:person-activate-generatelink][policy:GENERATE_ACTIVATION_LINK]" headers: Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.activate.generatelinkrequest.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.activate.generatelinkrequest.v1+json: schema: generatelinkrequest responses: "200": description: secret as base64 encoded in response if mediatype included (includeSecret=true) or mail sent without response if mediatype is not included. body: application/vnd.com.covisint.platform.person.activate.generatelinkrequest.v1+json: schema: generatelinkresponse "204": description: Email is generated and sent to user. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:resource:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + user.status.invalid - Only pending and inactive users are allowed to get email to get activated. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /tasks/activate/validatelink: description: "collection endpoint for validating email link posted is valid, to activate user [Since:3.0]" post: description: "validating email link posted is valid.[flow-name:person-activate-validatelink][policy:VERIFY_ACTIVATION_LINK]" headers: Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.activate.validatelinkrequest.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.activate.validatelinkrequest.v1+json: schema: validatelinkrequest responses: "204": description: secret from Email is validated. body: application/vnd.com.covisint.person.activate.reset.validatelinkresponse.v1+json: schema: validatelinkresponse "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:resource:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + user.activation.invalid.code - Activation code invalid. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /count: description: "Count endpoint for person [Since:2.0]" is: [secured] get: description: "Returns the count of person.[flow-name:person-get-count][policy:RETRIEVE_PERSONSCOUNT]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: text/plain Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: Retrieve persons for a supplied person identifier. Multiple values may be provided, in which case all found ids will be returned. type: string required: false repeat: false organization.id: description: Retrieve all persons belonging to this organization. type: string required: false repeat: false username: description: Retrieve all persons matching this username. type: string required: false repeat: false authnDomain: description: Constraint the search to persons with accounts in the given authentication domain (optional parameter). This value must only be provided with the username parameter. type: string required: false repeat: false name.given: description: Retrieve persons for a supplied given name. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name.surname: description: Retrieve persons for a supplied surname. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false email: description: Retrieve persons for a supplied email address. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false responses: "200": description: The total number of persons successfully retrieved (response collection may be empty). body: application/text: "400": description: | There was a problem with the client's request Substatus codes are mentioned below: + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured] /roles/{personId}: description: Returns a list of roles and privileges for the given person. uriParameters: personId: displayName: personId type: string required: true repeat: false is: [secured] get: description: "This endpoint gets the list of roles for person and also will get the only roles if we pass the onlyroles is equal to true as a media type parameter [Since:3.0][flow-name:person-get-roles-privileges][policy:RETRIEVE_PERSONROLES]" headers: Accept: description: Media type for person's roles and privileges. type: string required: true repeat: false example: "application/vnd.com.covisint.platform.person.role.v1+json:onlyroles=true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person's roles and privileges was successfully retrieved. body: application/vnd.com.covisint.platform.person.role.v1+json: schema: roles "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /{personId}/roles/grantable: description: Returns a list of grantable roles and privileges for the given person. uriParameters: personId: displayName: personId type: string required: true repeat: false is: [secured] get: description: "This endpoint gets the list of roles for person and also will get the only roles if we pass the onlyroles is equal to true as a media type parameter [Since:3.6][flow-name:person-get-grantable-roles-privileges][policy:RETRIEVE_GRANTABLEROLES]" headers: Accept: description: Media type for person's grantable roles and privileges. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.role.v1+json;onlyroles=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person's grantable roles and privileges was successfully retrieved. body: application/vnd.com.covisint.platform.person.role.v1+json: schema: roles "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /requestHistory: description: Endpoint used to get the person request history. is: [secured] /statusHistory: description: Endpoint used to get the person status history. is: [secured] /registration: description: Endpoint for registering a user. is: [unsecured] post: description: 'Register a new user. This end point create person, add password account, updating security questions(if provided) and updating the extended attributes. The status of the registered user is "pending".[Since:3.0][Flow-name:person-register-person][policy:CREATE_PERSONREG]' headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.password.account.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c body: application/vnd.com.covisint.platform.person.password.account.v1+json: schema: personPasswordAccount responses: "201": description: A new person was successfully registered. body: application/vnd.com.covisint.platform.person.password.account.v1+json: schema: personPasswordAccount "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /status: description: This endpoint used to get the user's registration status. First will check whether user is authenticated or not basis on passowrd. is: [unsecured] post: description: "This endpoint used to get the user's registration status. First will check whether user is authenticated or not basis on passowrd[Since:3.0][Flow-name:person-get-registration-status][policy:RETRIEVE_PERSONREGSTATUS]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.authn.password.req.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c body: application/vnd.com.covisint.platform.authn.password.req.v1+json: schema: PasswordAuthenticationRequest responses: "200": description: The user's registration status was successfully retrieved. body: text/plain: schema: registrationStatus "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request __ + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + person.usernme.does.not.exist - The person's user name does not exit. + Exception.occurred.during.password.authenticate - Exception occured during get person's passowrd authenticate. + unauthenticated.password.for.user - The passowrd is not authenticated for corresponding user. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /registration/validate: description: Endpoint for validating email address and/or user name. is: [unsecured] post: description: | Validate the email address and/or user name exists. Email address and/or user name provides as parameters.[Since:3.0][Flow-name:person-validate-registration][policy:VALIDATE_PERSONEMAILADDRESS] headers: SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: emailAddress: description: Validates the provided email address exists. type: string required: false repeat: false userName: description: Validates the provided user name address exists. type: string required: false repeat: false responses: "204": description: Email Address and/or User Name is not in use "404": description: | Email Address and/or User Name is already exists __ + person.account.duplicate.email-The email address :{emailAddress} is exists. + person.account.duplicate.username-The user name :{userName} is exists. + person.account.duplicate.username.email -Provided both user name and email address is exists:{userName},{emailAddress} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with paramaters __ + person:account:param:missing - At least one of the parameter (emailAddress or userName) should present. + person.account.multiple.username.not.allowed - Multiple user names are not allowed. + person.account.multiple.email.not.allowed - Multiple email address are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /myprofile: description: Individual endpoint for person (requestor's) resources. is: [secured] get: description: "Returns a person (requestor) by id.[Since:3.12][flow-name:person-get-myprofile]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json;includeSecurityAccount=true;includePackageGrants=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person resource was successfully retrieved. body: application/vnd.com.covisint.platform.person.v1+json: schema: personMyProfile "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /impersonate: description: Endpoint for impersonating an end-user (by obtaining end-user's JWT token). is: [secured] post: description: "Impersonate an end-user. This end point is used to get the JWT token of the end-user to be impersonated. [Since:3.15][Flow-Name:person-attribute-impersonate][policy:IMPERSONATE]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.token.v1+json Content-type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.impersonate.token.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.impersonate.token.v1+json: schema: personImpersonationRequest responses: "200": description: The JWT token of the end-user is successfully retrieved. body: application/vnd.com.covisint.platform.person.token.v1+json: schema: jwtTokenResponse "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:data:missing - The following information was missing from the resource: {missing} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {attributeValue} + invalid.attribute.value - More than one resource was found for provided attribute. "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: | Unauthorized. ___ Substatus codes and error messages are mentioned below: + person.request.unauthorized.user - SUBJECT_UNAUTHORIZED: Subject either doesn't have the required privileges or resource doesn't fall under subject's organization heirarchy + person.request.unauthorized.user - Requestor type {RequestorType} is not authorized body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /{personId}: description: Individual endpoint for person resources. uriParameters: personId: description: The person's unique identifier. type: string required: true repeat: false is: [secured] get: description: "Returns a person by id.[Since:1.0][flow-name:person-get-person][policy:RETRIEVE_PERSON]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json;lastlogindate=true;includenotificationprefs=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person resource was successfully retrieved. body: application/vnd.com.covisint.platform.person.v1+json: schema: person example: | { "id": "TESTUSER", "version": 1397188800000, "creator": "TESTUSER", "realm": "PROD", "status": "active", "name": { "prefix": "Mr.", "given": "John", "middle": "M", "surname": "Smith", "suffix": "Sr." }, "addresses": [ { "streets": [ "1 Main Street", "Suite 200", "c/o Ann Miller" ], "city": "Detroit", "state": "MI", "postal": "48303", "country": "US", "type": "main" } ], "language": "en", "timezone": "EST5EDT", "phones": [ { "type": "main", "number": "313-288-2562" }, { "type": "mobile", "number": "248-767-1572" }, { "type": "fax", "number": "248-476-1303" } ], "title": "Security Administrator", "email": "admin@covisint.com", "currency": "USD" } "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] put: description: "Updates a person's base demographical properties.[Since:1.0][flow-name:person-update-person][policy:UPDATE_PERSON]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.v1+json: schema: person responses: "200": description: The person resource was successfully updated. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + user:request:invalid:phone:type - Unsupported Phone type: {phoneType(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + person.invalid.emailIdFormat - Invalid email id format {emailId} + person.addresses.country - Invalid country code -{country} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] delete: description: "Delete a person. [Since:3.1][flow-name:person-delete-person][policy:DELETE_PERSON]" headers: suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: reason: description: reason for person deletion. type: string required: false repeat: false responses: "204": description: The person was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] /impersonate: description: Endpoint for impersonating an end-user (by obtaining end-user's JWT token) is: [secured] get: description: "Impersonate an end-user. This end point is used to get the JWT token of the end-user to be impersonated.[Since:3.12][Flow-Name:person-impersonate][policy:IMPERSONATE]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.token.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The JWT token of the end-user is successfully retrieved. body: application/vnd.com.covisint.platform.person.token.v1+json: schema: jwtTokenResponse "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /move/organization/{organizationId}: description: Endpoint to move user from one organization to another organization uriParameters: organizationId: displayName: organizationId type: string required: true repeat: false is: [secured] put: description: "Moves a user.[Since:3.16][flow-name:person-move-user][policy:MOVE_USER]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person resource was successfully moved. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:data:invalid - The user cannot be moved because he/she is the only Security Administrator in the organization + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: | Unauthorized ___ Substatus codes and error messages are mentioned below: + framework:request:Forbidden - Subject does not have valid priviliges + framework:request:Forbidden - Org is not present in subject's org hierarchy body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] /accounts/password: description: A person's password account, comprised of a username and password. is: [secured] put: description: "Create or update the password account.[Since:1.0][flow-name:person-update-password-account][policy:UPDATE_PASSWORDACCOUNT]" headers: Accept: description: Media type for person's password account. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.account.password.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.account.password.v1+json: schema: passwordAccount responses: "200": description: The person's password account was successfully updated. If the person was in unactivated status before the request then the person is changed to pending status. body: application/vnd.com.covisint.platform.person.account.password.v1+json: schema: passwordAccount "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + add.user.cleartrust.error - Could not add person to cleartrust + invalid.password.error - Password {password} does not conform to policy {passwordPolicy} + password.account.update.error - There was an error updating the password account + password.account.duplicate.username - Username already exists body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putCreateResponse] get: description: "Returns the person's password account [Since:1.0][flow-name:person-get-password-account][RETRIEVE_PASSWORDACCOUNT]" headers: Accept: description: Media type for a person password account. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.account.password.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person's password account was successfully retrieved. body: application/vnd.com.covisint.platform.person.account.password.v1+json: schema: passwordAccount "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + service.invalid.person.account.password - Account for Person {personId} does not exist. + password.account.get.error - There was an error getting the password account body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured, getResponse] /history: description: "Endpoint used to get password changes history. [Since:3.3]" is: [secured] get: description: "Endpoint used to get password changes history.[flow-name:person-password-change-history][policy:RETRIEVE_PERSONPASSWORDHISTORY]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.authn.password.change.history.req.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: eventType: description: The event type of the person. type: string required: false repeat: false passwordUpdatedUserId: description: The password updated user id. type: string required: false repeat: false responses: "200": description: The password changes history was successfully retrieved body: application/vnd.com.covisint.platform.authn.password.change.history.req.v1+json: schema: passwordChangesHistory "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + person.userId.missing - The user id is missing: {userId} + person.multiple.userId.not.allowed - Multiple userId are not allowed. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /templates: description: The collection of person API for extended attributes. is: [secured] put: description: "This endpoint updates an person with set of extended attributes. First it will verify the provided extended attributes are exists. If doesn't exist then it will throw an exception. It will always updates the provided attributes with the specified values, if attributes already exists but not provided by the client then it will ignore to update those attributes. [Since:3.0][flow-name:person-update-extended-attributes][policy:UPDATE_PERSONTEMPLATES]" headers: Accept: description: Media type for person's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.attribute.template.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.attribute.template.v1+json: schema: attributeTemplate responses: "200": description: The Person is successfully updated with extended attributes. body: application/vnd.com.covisint.platform.person.attribute.template.v1+json: schema: attributeTemplate "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + update.attribute.template.response + person.id.does.not.exist- The person id does not exist. + attribute.template.does.not.exist - The attribute template does not exist. + attribute.template.type - The attribute template type should be a peron type. + attributes.were.not.matched - The provided attributes were not matching with corresponding attribute templates. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] delete: description: "This endpoint deletes an extended attribute for the person. [Since:3.0][flow-name:person-delete-extended-attributes][policy:DELETE_PERSONTEMPLATES]" headers: Accept: description: Media type for person's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.attribute.template.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: id: description: The name of the attribute. type: string required: false repeat: false responses: "204": description: The attributes are associated with person were successfully deleted. body: application/vnd.com.covisint.platform.person.attribute.template.v1+json: "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + person.does.not.exis - The person id does not exist. + attributes.does.not.exist.for.person - The person doesn't have extended attributes. + attributes.does.not.associated - The attribute{s} is{are} not associated with person. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] get: description: "This endpoint gets an extended attribute templates associated with the person. [Since:3.0][flow-name:person-get-extended-attributes]" headers: Accept: description: Media type for person's attribute template. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.attribute.template.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: The attribute templates are associated with person were successfully ret. body: application/vnd.com.covisint.platform.person.attribute.template.v1+json: schema: attributeTemplate "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + User.doesn't.have.extended.attributes - User doesn't have associated with any extended attributes. + Exception.occurred.during.get - Exception occured during get person's extended attributes. + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /tasks/activate: description: Activate a person that is in pending status. A common workflow is (1) POST /person, which creates a person in unactivated status. (2) PUT /person/{personId}/accounts/password, which adds a password account to the person and moves the person to pending status. (3) PUT /tasks/activate, which activates the person and moves the person to active status. is: [secured] post: description: "Activate a person that is in pending status. [Since:1.0][flow-name:person-task-activate-person][policy:ACTIVATE_PERSON]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: personId: description: The unique identifier of the person to activate. type: string required: true repeat: false responses: "204": description: The person resource was successfully activated. The person is changed to active status. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:resource:state:transition:unsupported - Unsupported person status transition from {fromState} to ACTIVATE + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/suspend: description: Suspend a person that is in active status. is: [secured] post: description: "Suspend a person that is in active status. [Since:1.0][flow-name:person-task-suspend-person][policy:SUSPEND_PERSON]" headers: suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: personId: description: The unique identifier of the person to suspend. type: string required: true repeat: false responses: "204": description: The person resource was successfully suspended. The person is changed to suspended status. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to SUSPEND + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/unsuspend: description: Unsuspend a person that is in suspended status. is: [secured] post: description: "Unsuspend a person that is in suspended status. [Since:1.0][flow-name:person-task-unsuspend-person][policy:UNSUSPEND_PERSON]" headers: suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: personId: description: The unique identifier of the person to unsuspend. type: string required: true repeat: false responses: "204": description: The person resource was successfully unsuspended. The person is changed to active status. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + framework:resource:state:transition:unsupported - Unsupported person status transition from {status} to UNSUSPEND + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | Resource not found. ___ Substatus codes and error messages are mentioned below: + framework:resource:missing - A resource with the following ID was not found: {resourceId} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /password/validate: description: "collection endpoint to validate password against policy resources retrieved by using InviteId and orgnizationId.[Since:3.0]" is: [secured] post: description: "collection endpoint to validate password against policy resources retrieved by using InviteId and orgnizationId.[flow-name:person-validate-password][policy:VALIDATE_PERSONPASSWORD]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.password.validation.response.v1+json Content-type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.password.validation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.password.validation.v1+json: schema: passwordValidationRequest responses: "200": description: The password comply with corresponding password policy. body: application/vnd.com.covisint.platform.password.validation.response.v1+json: schema: passwordValidationResponse "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:io:read - There was an error while reading the request body. + framework:request:io:read:parsing - Invalid input. There was a error while parsing the request body. + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.organization.id.not.exist.for.inviteId - The organization id does not exist for invite Id: {inviteId} + password.validate.response + password.request.operation.valid.values - password request operation value should be any of the: {AUTHENTICATE, PASSWORD_RESET, PASSWORD_SPECIFY, PASSWORD_CHANGE, EXPIRED_PASSWORD_CHANGE} + person.organization.id.not.exist - The organization id does not exist: {organizationId} + person.password.policy.id - The password policy with organization does not exist: {passwordPolicyId} + person.password.policy.id.not.valid - The password policy id is not valid: {passwordPolicyId} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /organizations/{organizationId}/securityAdmins: uriParameters: organizationId: displayName: organizationId type: string required: true repeat: false is: [secured] get: description: "Searches security admins according to the organization id provided.[Since:3.1][flow-name:person-get-organization-security-admins][policy:RETRIEVE_ORGSECURITYADMINS]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" responses: "200": description: All matching security admins were successfully retrieved, if organization is provided, then return the persons which are security admins for the organizations. body: application/vnd.com.covisint.platform.person.v1+json: schema: person "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invalid.searchParams - Searching for persons across different realms is not allowed + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /roles: description: Endpoint for assigning roles to a user. is: [secured] post: description: "Assigns a role to the person. [Since:3.7][flow-name:person-assign-roles][policy:CREATE_PERSONROLE]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.assign.role.v1+json Content-type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.assign.role.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.assign.role.v1+json: schema: personRole responses: "201": description: A role has been assigned to a person. body: application/vnd.com.covisint.platform.person.assign.role.v1+json: schema: personRole "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + person.role.id.invalid - The role id must be a number + userId.not.exists - user with given id does not exist in active status + roles.not.exist - The roles do not exist + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /remove/roles: description: Endpoint for deleting/removing roles assigned to a user. is: [secured] post: description: "deletes the role from person. [Since:3.8][flow-name:person-remove-roles][policy:DELETE_PERSONROLE]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.remove.v1+json Content-type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.remove.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.remove.v1+json: schema: deletePersonRole responses: "201": description: A role has been deleted from the person. body: application/vnd.com.covisint.platform.person.delete.role.v1+json: schema: deletePersonRole "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + person.role.id.invalid - The role id must be a number + userId.not.exists - user with given id does not exist in active status + roles.not.exist - The roles do not exist + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /{personId}/updateUserName: description: Updates person username (idpUserId). uriParameters: personId: displayName: personId type: string required: true repeat: false is: [secured] post: description: "Updates person username (idpUserId). [Since:3.8][flow-name:person-update-username][policy:UPDATE_USERNAME]" headers: suppressNotification: description: Notification generation flag. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: username: description: Persons user name(idpUserId). type: string required: true repeat: false responses: "204": description: Persons user name succesfully updated. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + person.request.update.username - Can update ACTIVE and SUSPENDED users. + person.request.update.username - Can update with unique username in realm and auth domain. + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /token: description: Get JWT token for a trusted user. is: [secured] get: description: "Get JWT token for a trusted user. [Since:3.11][flow-name:person-get-token]" headers: Content-type: description: Media type for getting JWT token. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.token.v1+json Accept: description: Media type for getting JWT token. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.token.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: JWT token for given cuid of subject. body: application/vnd.com.covisint.platform.person.token.v1+json: schema: jwtTokenResponse "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /personInvitations: description: Collection endpoint for person invitation resources is: [secured] get: description: "Performs a search for person invitations. [Since:1.0][flow-name:person-search-personinvitation][policy:RETRIEVE_PERSONINVITATIONS]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.invitation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: invitor.id: description: Only retrieve person invitations for a certain invitor. This parameter may be repeated to search for multiple invitors. type: string required: false repeat: false invitee.id: description: Only retrives person invitations for a certain invitee. This parameter may be repeated to search for multiple invitees. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" responses: "200": description: All person invitations that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.person.invitation.v1+json: schema: personInvitation "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invitation.invalid.combination.queryParamaters - Searching for persons across different realms is not allowed + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] post: description: "Creates a new person invitation. [Since:1.0][flow-name:person-create-personinvitation][policy:CREATE_PERSONINVITATION]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.invitation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.invitation.v1+json: schema: personInvitation responses: "201": description: A new person invitation was created and is returned in the response body. body: application/vnd.com.covisint.platform.person.invitation.v1+json: schema: personInvitation "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invitation.invalid.emailIdFormat - Invalid email id format {emailId} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} + invalid.invitee - The invitee does not exist + invalid.targetOrganizationId - OrganizationId of invitee doesn't match with target organizationId body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /{invitationId}: description: Endpoint for an individual person invitation. uriParameters: invitationId: description: Unique identifier of the person invitation. type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "Returns the person invitation by id. [Since:1.0][flow-name:person-get-personinvitation][policy:RETRIEVE_PERSONINVITATION]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.invitation.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person invitation was successfully retrieved body: application/vnd.com.covisint.platform.person.invitation.v1+json: schema: personInvitation "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [secured, getResponse] delete: description: "Deletes a person invitation. [Since:3.4][flow-name:person-delete-personinvitation][policy:DELETE_PERSONINVITATION]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The person invitation was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] /servicePackages: description: "Packages associated with an invitation. [Since:2.0]" is: [secured] get: description: "Returns the service packages associated to an invitation.[flow-name:person-get-invitation-packages]" headers: Accept: description: Media type for service package. type: string required: true repeat: false example: application/vnd.com.covisint.platform.resourceReferences.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The references to the packages were successfully retrieved. This will be an empty array if no packages exist. body: application/vnd.com.covisint.platform.resourceReferences.v1+json: schema: resourceReference "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /{packageId}: uriParameters: packageId: description: Unique identifier of the package type: string required: true repeat: false maxLength: 36 is: [secured] put: description: "Sets a package as being part of an invitation.[flow-name:person-get-invitation-package-by-id]" headers: Content-type: description: Media type for service package. type: string required: true repeat: false example: application/vnd.com.covisint.platform.resourceReferences.v1+json Accept: description: Media type for service package. type: string required: true repeat: false example: application/vnd.com.covisint.platform.resourceReferences.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The service package was successfully added to the invitation. body: application/vnd.com.covisint.platform.resourceReference.v1+json: schema: resourceReference "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] delete: description: "Deletes the package from being associated to the invitation.[flow-name:person-delete-invitation-package-by-id]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The package was successfully deleted from the invitation. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] /codes: is: [secured] get: description: "Returns the service codes associated to a service package associated to an invitation.[flow-name:person-get-invitation-package-codes]" headers: Accept: description: Media type for service code. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.codes.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The service codes were successfully retrieved. This will be an empty array if no codes exist. body: application/vnd.com.covisint.platform.service.codes.v1+json: schema: service.codes "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] put: description: "Updates the codes for a service package associated to an invitation.[flow-name:person-update-invitation-package-codes]" headers: Content-type: description: Media type for service code. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.codes.v1+json Accept: description: Media type for service code. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.codes.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The service codes were successfully updated. body: application/vnd.com.covisint.platform.service.codes.v1+json: schema: service.codes "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "409": description: | There is a conflict in identifying the resource being acted on. There are two categories. (1) The unique identifier in the URL and in the body are different. (2) The current version of the resource being updated and the version sent in the body of the request. This may be an indication that the resource has changed since the client loaded it. The conflict should be resolved and the update resubmitted with the current version of the resource. + framework:resource:conflict + framework:resource:conflict:id - The ID of the resource in the request, {requestedId}, does not match the ID of the given resource, {resourceId} + framework:resource:conflict:version - The version of the provided resource, {requestVersion}, does not match the current version of the resource, {latestVersion} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [putResponse] delete: description: "Deletes the codes for a service package associated to an invitation.[flow-name:person-delete-invitation-package-codes]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The codes were successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse] /tasks/accept: description: "Task to accept a person invitation by id. [Since:1.0]" is: [unsecured] post: description: "Accept the person invitation. This also results in the invitation being deleted.[Flow-name:person-task-accept-personinvitation]" headers: SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: inviteId: description: The unique identifier of the invitation being accepted. type: string required: true repeat: false createdPersonId: description: The unique identifier of the person created during the registration process that was initiated by the accepted invitation. This is specified solely for tracking purposes. type: string required: true repeat: false responses: "204": description: The invitation was successfully accepted. "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invitation.invalid.inviteId - Invite id {inviteId} does not exist + person.invitation.invalid.personId - Person id {personId} does not exist + person.invitation.multiple.inviteIds.not.allowed - Multiple inviteIds are not allowed. + person.invitation.multiple.createdPersonIds.not.allowed - Multiple createdPersonIds are not allowed. + person.invitation.conflict.personId - Person id {personId} is not matching with the invited id {inviteeId}. + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /requests: description: Collection endpoint for person registration request resources. is: [secured] get: description: "Performs a search for person registration requests. [Since:1.0][flow-name:person-search-requests][policy:RETRIEVE_PERSONREQUESTS]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json;includedivision=true Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: registrant.id: description: Retrieve person requests for a supplied person identifier. type: string required: false repeat: false organizationId: description: Retrieve person requests for the organization id. type: string required: false repeat: false page: description: Which page to return in the paginated results. The first page is page 1. type: integer required: false repeat: false minimum: 1 default: "1" pageSize: description: How many items per page in the paginated results. type: integer required: false repeat: false minimum: 1 maximum: 2E+2 default: "50" responses: "200": description: All person requests that satisfy the search criteria were successfully retrieved. body: application/vnd.com.covisint.platform.person.request.v1+json: schema: personRequest "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.request.invalid.searchParams - Searching for registrants across different realms is not allowed + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest, secured] post: description: "Creates a new person request. [Since:1.0][flow-name:person-create-request][policy:REQUEST_PERSONREG]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.request.v1+json: schema: personRequest responses: "201": description: A new person registration was created and is returned in the response body. body: application/vnd.com.covisint.platform.person.request.v1+json: schema: personRequest "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:resource:missing - The following resources were not found: {resources} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, secured] /{requestId}: description: Endpoint for an individual person request. uriParameters: requestId: description: Unique identifier of the person request type: string required: true repeat: false maxLength: 36 get: description: "Returns a person request by id. [Since:1.0][flow-name:person-get-request][policy:RETRIEVE_PERSONREQUEST]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "200": description: The person request was successfully retrieved. body: application/vnd.com.covisint.platform.person.request.v1+json: schema: personRequest "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse, secured] delete: description: "Deletes a person request. [Since:1.0][flow-name:person-delete-request][policy:DELETE_REQUEST]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: The person request was successfully deleted. "400": description: | There was a problem with the client's request ___ Substatus codes are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [deleteResponse, secured] /tasks/approve: description: Approve a person request. is: [secured] post: description: "Approve a person request. [Since:1.0][flow-name:person-task-accept-request][policy:APPROVE_PERSONREQUEST]" headers: Accept: description: Media type for person request. Setting grantdefaultpackage media type attribute to true to grant the exchange package along with the requested package. type: string required: false repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json;grantdefaultpackage=true suppressNotification: description: Media type for person. type: string required: false repeat: false example: "true" Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: requestId: description: The unique identifier of the person request. type: string required: true repeat: false responses: "204": description: The request was successfully approved. The person is put into active status. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + person.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /tasks/deny: description: It will deny the person request as well as requested package and exchange package id granted the user. is: [secured] post: description: "It will deny the person request as well as requested package and exchange package id granted the user. [Since:2.0][flow-name:person-task-deny-request][policy:DENY_PERSONREGREQUEST]" headers: Accept: description: Media type for person request. type: string required: false repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: requestId: description: The unique identifier of the person request. type: string required: true repeat: false reason: description: The justification for the request. type: string required: false repeat: false responses: "204": description: The request was successfully denied. The person has moved into removed state. "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:resource:state:transition:unsupported - Unsupported person status transition from {status1} to {status2} + framework:request:invalid:header - Invalid x-requestor header value. The correct format is {requestorType}requestor. + framework:request:invalid:header:value - Invalid x-requestor header value. + person.request.multiple.requestIds.not.allowed - Multiple requestIds are not allowed. + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /userInfo: description: Endpoint for user related claims. is: [secured] get: description: "Get user claims based on scope and subject id.[Since:1.0][flow-name:person-get-user-info]" headers: Accept: description: Media type for a user info resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.userinfo.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: scope: description: The scope as per the OIDC spec. For example, scope = profile email. type: string required: false repeat: false responses: "200": description: User claims based on scope and subject id are retrieved succesfully. body: application/vnd.com.covisint.platform.userinfo.v1+json: schema: userInfo "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + userinfo.request.x-requestor.invalid - The user with the x-requestor header does not exist body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /{id}: description: Individual resource endpoint for userInfo resource. uriParameters: id: description: The unique userInfo identifier. type: string required: true repeat: false maxLength: 36 is: [secured] /person/detailedStatusHistory: description: Endpoint used to get the person status history between specficed dates. For getting current date history lastDate should be the next day date. is: [secured] get: description: "Endpoint used to get the person status history.[Since:3.1][flow-name:person-get-detailed-status-history]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.detail.status.history.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk queryParameters: status: description: The status of the person. type: string required: false repeat: false userId: description: The person's registration id. type: string required: false repeat: false startDate: description: The date from which status history starts (eg. dd-MMM-yyyy). type: string required: true repeat: false lastDate: description: The date till which status history to be shown (eg. dd/mmm/yyyy). This date history will not be the part of response. type: string required: true repeat: false responses: "200": description: The person's status history was successsfully retrieved. body: application/vnd.com.covisint.platform.person.detail.status.history.v1+json: schema: personDetailStatusHistory "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + person.userId.missing - The user id is missing: {userId} + person.multiple.userId.not.allowed - Multiple userId are not allowed. + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /persons/notification/preferences: description: Endpoint used to update the person email or sms subscription. is: [secured] post: description: "Endpoint used to update the person email or sms subscription.[Since:1.0][flow-name:person-update-notification-preferences][policy:UPDATE_NOTIFICATION_PREFERENCES]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.notification.preferences.v1+json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk body: application/vnd.com.covisint.platform.person.notification.preferences.v1+json: schema: userNotificationPerferences responses: "200": description: The person update his email/sms subscription successfully. body: application/vnd.com.covisint.platform.person.notification.preferences.v1+json: schema: userNotificationPerferences "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + person.userId.missing - The user id is missing: {userId} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + framework:request:data:invalid - The following information should not be part of the resource: {resourceFieldName} + framework:resource:data:illegal - The following information was illegal from the resource: {fieldSpecificError(s)} + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "415": description: | Unable to consume content of specified 'Content-Type' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to consume content of type {contentMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "401": description: Unauthenticated request. This is returned if the access token is missing, invalid, or expired. Access tokens are obtained through the /token endpoint of the Oauth API. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse] /persons/notification/preferences/{userId}: uriParameters: userId: description: The person's unique identifier. type: string required: true repeat: false get: description: "Searches person notification preferences resources according to the filter criteria provided.[Since:1.0][flow-name:person-get-notification-preferences][policy:GET_NOTIFICATION_PREFERENCES]" headers: Accept: description: Media type for person. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.notification.preferences.v1+json queryParameters: eventId: description: Retrieve persons notification preference for a supplied event identifier. type: string required: false repeat: false responses: "200": description: All matching person notification preference resources were successfully retrieved. body: application/vnd.com.covisint.platform.person.notification.preferences.v1+json: schema: userNotificationPerferences "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io + framework:request:io:read - Invalid input. There was an error while parsing. + framework:request:io:read:parsing + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + framework:request:data:missing - The following information was missing from the resource: {resourceFieldName(s)} + person.invalid.searchParams - Searching for persons across different realms is not allowed + person.status.value.invalid - Searching for persons with status value is not valid + framework:request:invalid:header:value - Invalid x-requestor header value. Valid values are [person, application] + framework:request:param:invalid - The following parameter should not be part of the request: {queryParameterName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "404": description: | The URI requested is invalid or the resource requested does not exist. ___ Substatus codes and error messages are mentioned below: + (If a resource id is a URI parameter) framework:resource:missing - A resource with the following ID was not found: {resourceId} + No message for an invalid URI body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "406": description: | Unable to produce content of specified 'Accept' media type ___ Substatus codes and error messages are mentioned below: + framework:request:unsupported:mediatype - The server is unable to produce content of type {acceptMediaType} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema "500": description: | An unknown server error occurred ___ Substatus codes and error messages are mentioned below: + framework:unknown body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse]