#%RAML 0.8 title: Unified service for Registration baseUri: "https://apistg.np.covapp.io/registration/v1" 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" ] } ] } - passwordPolicy: | { "id" : "http://api.covisint.com/schema/passwordPolicy", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an password policy resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "status" : { "type" : "string", "enum" : [ "active", "inactive", "deleted" ], "description" : "The status of the password policy." }, "name" : { "type" : "string", "description": "The name of password Policy." }, "desc": { "type" : "string", "description": "The description for password Policy." }, "rules" : { "type" : "array", "description" : "Password Policy Rules", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/idm/schema/passwordRule#" } } } ,"required": [ "properties", "name" ] } - 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": [ "surname", "given" ] }, "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": [ "type","id"] }, "currency" : { "type" : "string", "maxLength" : 3, "description" : "The person's preferred currency. Must be a valid ISO4217 currency code." } },"required": [ "email", "title", "timezone", "language","name","id","creation","creatorAppId","creator" ] }, "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": [ "type" ] }, "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": [ "type" ] }, "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","id","creation","creatorAppId","creator","password" ], "securityQuestionAccount" : { "description": "The security questions associated with the person.", "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", "questions", "creation", "creatorAppId","creator" ] } }, "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", "attributes", "creation", "creatorAppId","creator" ], "inviteId":{ "type": "string", "description": "The invite id for person." }, "pin":{ "type": "string", "description": "The invitation pin for person. Required in case of secured-invitation" } } } ,"required": [ "person", "passwordAccount" ] } - package: | { "id" : "http://api.covisint.com/schema/service", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a package 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 should not be supplied for POST requests. User supplied value will be ignored and will be set to the creation value." }, "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" ] } } ,"required": [ "restriction", "requestorType" ] }, "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 } } ,"required": [ "tacId"] } }, "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#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "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": [ "category", "name","owningOrganization" ] } - attributeReference: | { "id" : "http://api.covisint.com/schema/attributeReference", "$schema" : "http://json-schema.org/draft-04/schema", "description" : "Schema representing attribute reference", "type" : "array", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the attribute." }, "name" : { "type" : "string", "description" : "The name of the attribute." }, "defaultValue" : { "type" : "object", "description" : "The default value of the attribute." } } ,"required": [ "id" ] } - attributeTemplate: | { "id" : "http://api.covisint.com/schema/attributeTemplate#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an attribute template.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "name" : { "description" : "The name of the attribute template.", "type" : "string", "maxLength" : 100 }, "description" : { "description" : "The description of the attribute template.", "type" : "string", "maxLength" : 1000 }, "type" : { "description" : "The type of the attribute template.", "enum" : [ "PERSON", "ORGANIZATION"], "maxLength" : 25 }, "attributes" : { "description" : "The attributes which belongs to the attribute template.", "$ref" : "http://api.covisint.com/schema/attributeReference#" } } ,"required": [ "attributes", "type", "name"] } - attributeTemplates: | { "type" : "array", "description" : "The collection of attributeTemplates.", "items" : { "$ref" : "http://api.covisint.com/schema/attributeTemplate#"} } - attribute: | { "id" : "http://api.covisint.com/schema/attribute#", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an attribute.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResource2#" }, "properties" : { "name" : { "description" : "The name of the attribute.", "type" : "string", "maxLength" : 100 }, "type" : { "description" : "The type of the attribute.", "enum" : [ "String", "Integer" ], "maxLength" : 100 }, "entity" : { "description" : "The kind of entity of the attribute.", "enum" : [ "PERSON", "ORGANIZATION" ], "maxLength" : 255 }, "description" : { "description" : "The description of the attribute.", "type" : "string", "maxLength" : 1000 }, "isDisplayable" : { "description" : "The flag which says the attribute is displayable.", "type" : "boolean", "maxLength" : 1 }, "isActive" : { "description" : "The flag which says weather attribute is active.", "type" : "boolean", "maxLength" : 1 }, "description" : { "description" : "The description of the attribute context.", "type" : "string", "maxLength" : 100 }, "isAllowedInUserRule" : { "description" : "The flag which says attribute is allowed in user rule.", "type" : "boolean", "maxLength" : 1 }, "isEditable" : { "description" : "The flag which says the attribute is editable.", "type" : "boolean", "maxLength" : 1 }, "isFixed" : { "description" : "The flag which says the attribute is fixed.", "type" : "boolean", "maxLength" : 1 }, "isUnique" : { "description" : "The flag which says the attribute is unique.", "type" : "boolean", "maxLength" : 1 }, "isEditableByAdmin" : { "description" : "The flag which says the attribute is editable by admin.", "type" : "boolean", "maxLength" : 1 }, "isEditableOnRegistration" : { "description" : "The flag which says the attribute is editable on registration.", "type" : "boolean", "maxLength" : 1 }, "isRequired" : { "description" : "The flag which says the attribute is required.", "type" : "boolean", "maxLength" : 1 }, "isRequiredOnInvitation" : { "description" : "The flag which says the attribute is required on invitation.", "type" : "boolean", "maxLength" : 1 } } ,"required": [ "name", "type", "entity" ] } - packageGrant: | { "id" : "http://api.covisint.com/schema/packageGrant", "$schema" : "http://json-schema.org/draft-04/schema", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "type" : "object", "description" : "Representation of a package grant.", "properties" : { "id": { "description" : "id of package grant" }, "version": { "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. User supplied value will be ignored and will be set to the creation value." }, "status" : { "type" : "string", "enum" : [ "active", "suspended", "unactivated" ], "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#" } } ,"required": [ "servicePackage", "grantee" ] } - securityQuestions: | { "id" : "http://api.covisint.com/schema/securityQuestions/v2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "array", "description": "Collection of security questions.", "properties" : { "items": { "$ref": "http://api.covisint.com/schema/securityQuestion/v2" } },"required": [ "items" ] } - securityQuestion: | { "id" : "http://api.covisint.com/schema/securityQuestion/v2", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "A representation of a security questions.", "extends" : { "$ref" : "http://api.covisint.com/idm/schema/realmScopedResource#" }, "properties" : { "version": { "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. User supplied value will be ignored and will be set to the creation value." }, "owner": { "description": "The owner of this security question. Required only when creating or updating questions scoped to persons. For realm and organization scoped questions, this property is not required.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "question" : { "description": "Internationalized security question text.", "minItems": 0, "$ref" : "http://api.covisint.com/idm/schema/internationalString#" } } ,"required": [ "question" ] } - organization: | { "id" : "http://api.covisint.com/schema/organization/v1", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing an organization 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, and will be ignored for POST requests." }, "status" : { "enum" : [ "active", "suspended", "inactive", "unactivated" ], "description" : "The organization's status. This property is read-only. Status can be changed through tasks." }, "parentOrganization": { "description": "The parent organization. Used to create an organization hierarchy. Required when creating an organization, read only when updating.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "rootOrganization": { "description": "The organization at the root of this hierarchy. This is the top-most organization that does not have a parent. This property is read-only.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "name" : { "type" : "string", "description" : "The organization's name.", "maxLength" : 244 }, "phones" : { "type" : "array", "description" : "A container for the organization's phone number(s).", "minItems" : 0, "items" : { "$ref" : "http://api.covisint.com/schema/phone#" } }, "email" : { "type" : "string", "maxLength" : 1000, "description" : "The organization's email address." }, "url" : { "type" : "string", "description" : "A URL representing this organization.", "maxLength" : 1000 }, "authDomain" : { "type" : "string", "description" : "This organization's authentication domain.", "maxLength" : 50 }, "organizationType" : { "type" : "string", "description" : "The organization type. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 5, "default" : "AO" }, "organizationSubtype" : { "type" : "string", "description" : "The organization subtype. Unless there is reason to specify otherwise, this value doesn't need to be provided and will be defaulted.", "maxLength" : 10 }, "accountNumber" : { "type" : "string", "description" : "The organization account number.", "maxLength" : 50 }, "externalCode" : { "type" : "string", "description" : "Code assigned to identify the organization to external systems.", "maxLength" : 50 }, "duns" : { "type" : "string", "description" : "The organization DUNS number.", "maxLength" : 50 }, "classification" : { "type" : "string", "description" : "The organization classification.", "maxLength" : 100 }, "public" : { "type" : "boolean", "description" : "Whether this is a public organization. Defaults to true." }, "passwordPolicy" : { "description": "The password policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "authenticationPolicy" : { "description": "The authentication policy associated to this particular organization.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "attributes":{ "type": "array", "minItems": 1, "description": "The extended attributes for organization.", "items": { "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": [ "name"] } - 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": [ "surname", "given" ] }, "addresses" : { "type" : "array", "description" : "A container for the organization's addresses.", "minItems" : 1, "items" : { "required" : true , "ref" : "http://api.covisint.com/schema/address#", "properties" : { "streets" : { "minItems" : 1 }, "city" : { }, "state" : { }, "country" : { } } ,"required": [ "country", "state", "city", "streets" ] } }, "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": { "properties":{ "id": { "type": "string", "description": "The key name for the person's attribute template data." }, "name": { "type": "string", "description": "The name of the extended attribute." }, "value": { "type": "string", "description": "The text value." } } } } } ,"required": [ "organization", "email", "timezone", "language" ,"name" ] } - 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#" }, "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 ", "maxLength": 50 } } ,"required": [ "targetOrganization", "invitor", "email" ] } - requestresourceReference: | { "id" : "http://api.covisint.com/schema/requestresourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "$ref": "http://api.covisint.com/schema/resourceReference#", "description" : "Schema representing requestresourceReference", "type" : "object", "properties" : { "requestId" : { "type" : "string", "description" : "The request id for the resource." } } } - requestresourceReference: | { "id" : "http://api.covisint.com/schema/requestresourceReference", "$schema" : "http://json-schema.org/draft-04/schema", "$ref": "http://api.covisint.com/schema/resourceReference#", "description" : "Schema representing requestresourceReference", "type" : "object", "properties" : { "requestId" : { "type" : "string", "description" : "The request id for the resource." } } } - request: | { "id" : "http://api.covisint.com/schema/registration", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a registration request of a person/organization.", "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, if the request is organization request then the organization also should be in pending state.", "$ref": "http://api.covisint.com/schema/requestresourceReference#" }, "justification" : { "type" : "string", "description": "The justification for the registration.", "maxLength": 1000 }, "organization" : { "description": "The organization for the request.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "topOrganization" : { "description": "The top organization for the request.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "organizationName" : { "type" : "string", "description": "The name of the organization." }, "packages": { "type": "array", "$ref": "http://api.covisint.com/schema/requestresourceReference#", "properties": { "code": { "type": "string", "maxLength": 50, "description": "The code associated with the requested service package. To be specified if required by the service package." }, "codeKind": { "type": "string", "maxLength": 36, "description": "The kind of code. Only applicable if code is provided. This field is also known as business unit." } } } } ,"required": [ "registrant", "topOrganization", "organization", "justification" ] } - organizationInvitation: | { "id" : "http://api.covisint.com/schema/organizationInvitation", "$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 organization that is to be used during the registration initiated by this invitation. This is an optional way to prepopulate organization attributes at invitation time.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "targetOrganization": { "description": "The organization that the organization will join as a result of the registration initiatied by this invitation.", "$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 } } ,"required": [ "email", "targetOrganization", "invitor" ] } - application: | { "id" : "http://api.covisint.com/schema/application", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a application resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "id" : { "maxLength" : 15 }, "version": { "description" : "The current version for this resource. " }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized service descriptions. The description will be defaulted to the service name, if it is not provided for a language for which the service name is given.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "owningOrganization": { "description": "The organization that owns this service.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "urls": { "type": "array", "minItems": 1, "description": "A listing of all URLs defined for this service, by type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The URL type.", "maxLength": 100 }, "value": { "type": "string", "description": "The URL value.", "maxLength": 4000 } } } }, "remoteAppId": { "type": "string", "description": "Links this service to a remote application known to the client.", "maxLength": 500 }, "mobileServiceId": { "type": "string", "description": "Mobile service id.", "maxLength": 200 }, "federationConnectionWizard": { "type": "string", "maxLength": 255, "description": "Location of the federation connection set-up wizard. e.g. salesforce, unauthenticated website, etc." }, "protected": { "type": "boolean", "description": "Indicates whether this service is synced back to cleartrust entitlements server, and therefore protected by the ct web agent." }, "messagingEnabled": { "type": "boolean", "description": "Indicates whether to perform messaging when this service is updated." }, "mangledUrl": { "type": "string", "description": " The mangled/federated url of the service." }, "iconUrl": { "type": "string", "description": " The icon url of the service." }, "servicePackage": { "description": "The package this service belongs to.", "$ref": "http://api.covisint.com/schema/package#" }, "bundledApps":{ "type": "array", "description": "The array of bundled applications. Bundled applications are apps that are present in the app's package.", "$ref" : "http://api.covisint.com/schema/minimalApplication#" }, "relatedApps":{ "type": "array", "description": "The array of related applications. Related applications are apps that are present in the parent or sub packages and if they are fast reg enabled.", "$ref" : "http://api.covisint.com/schema/minimalApplication#" }, "grant": { "description": "The details of the grant.", "$ref": "http://api.covisint.com/schema/applicationGrant#" } } ,"required": [ "servicePackage", "urls", "owningOrganization", "category","name" ] } - service: | { "id" : "http://api.covisint.com/schema/service", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a service resource.", "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 ignore for POST requests. User supplied value will be ignored and will be set to the creation value." }, "name" : { "description": "Internationalized service names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "description" : { "description": "Internationalized service descriptions. The description will be defaulted to the service name, if it is not provided for a language for which the service name is given.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "parentService": { "description": "The parent service. Used to create a service hierarchy.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "category" : { "description": "Internationalized category names.", "$ref" : "http://api.covisint.com/idm/schema/internationalString#" }, "owningOrganization": { "description": "The organization that owns this service.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "urls": { "type": "array", "minItems": 1, "description": "A listing of all URLs defined for this service, by type.", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The URL type.", "maxLength": 100 }, "value": { "type": "string", "description": "The URL value.", "maxLength": 4000 } } } }, "remoteAppId": { "type": "string", "description": "Links this service to a remote application known to the client.", "maxLength": 500 }, "mobileServiceId": { "type": "string", "description": "Mobile service id.", "maxLength": 200 }, "federationConnectionWizard": { "type": "string", "maxLength": 255, "description": "Location of the federation connection set-up wizard. e.g. salesforce, unauthenticated website, etc." }, "protected": { "type": "boolean", "description": "Indicates whether this service is synced back to cleartrust entitlements server, and therefore protected by the ct web agent." }, "messagingEnabled": { "type": "boolean", "description": "Indicates whether to perform messaging when this service is updated." }, "mangledUrl": { "type": "string", "description": " The mangled/federated url of the service." }, "iconUrl": { "type": "string", "description": " The icon url of the service." } } ,"required": [ "urls", "name", "owningOrganization", "category" ] } - 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": [ "operations", "password" ] } - termsAndCondition: | { "id" : "http://api.covisint.com/schema/tac", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing a terms and condition resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/realmScopedResourceV2#" }, "properties" : { "isLatest" : { "type" : "boolean", "description": "The flag to notify the package's terms and condition is latest." }, "isReAcceptanceRequired" : { "type" : "boolean", "description": "The flag to notify the package's terms and condition is re-acceptance required." }, "tacText" : { "type" : "string", "description": "The Text of the package's terms and condition." }, "type" : { "type" : "string", "description": "The type of the package's terms and condition." }, "language" : { "type" : "string", "description": "The language of the package's terms and condition." }, "preTermsAndCondition" : { "description": "The parent terms and condition.", "$ref": "http://api.covisint.com/schema/resourceReference#" }, "servicePackage" : { "description": "The package of the terms and condition which belong to.", "$ref": "http://api.covisint.com/schema/resourceReference#" } } ,"required": [ "tacText", "language" ] } 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 /person: /task/delete: description: Collection endpoint for person delete. is: [secured] delete: description: "Delete a person. [Since:3.1][Flow-name:delete-person-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 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] /requests: description: Collection endpoint for person registration request resources. is: [secured] get: description: "Searches person request resources according to the filter criteria. [Since:1.1][Flow-name:registration-search-person-request]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json Content-Type: 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 queryParameters: registrant.id: description: The id of the registrant. type: string required: false repeat: false organization.id: description: The organization id of the registrant. type: string required: false repeat: false responses: "200": description: All matching person request resources were successfully retrieved. body: application/vnd.com.covisint.platform.person.request.v1+json: schema: request "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 "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] post: description: "Creates a new person request, service package requests if any. [Since:1.1][Flow-name:registration-create-person-request]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json Content-Type: 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 body: application/vnd.com.covisint.platform.person.request.v1+json: schema: request 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: request "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] /count: description: "Count endpoint for person request [Since:1.1]" get: description: "Returns the count of person requests.[Flow-name:registration-count-person-request]" headers: Accept: description: Used to request the appropriate package resource media type. type: string required: true repeat: false example: text/plain responses: "200": description: The total number of packages 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 /{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 is: [secured] get: description: "Returns a person request by id. [Since:1.0][Flow-name:registration-get-person-request]" 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: request "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] /tasks/approve: description: Approve a person request, grant the requested packages and the exchange service package id. is: [secured] post: description: "Approve a person request, grant the requested packages and the exchange service package id. [Since:1.1][Flow-name:registration-task-approve-person-request]" 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 reason for the approval. type: string required: false repeat: false justification: description: The justification for the approval. type: string required: false 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 packages and exchange package id. is: [secured] post: description: "It will deny the person request as well as requested packages and exchange package id. [Since:1.1][Flow-name:registration-task-deny-person-request]" 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] /organization/registration/{organizationId}/packages: description: collection endpoint for organization package grant resources uriParameters: organizationId: description: The id of the organization for whom this grant is being made. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for an organization's package grants. [Since:1.0][Flow-Name:service-search-organization-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 package grants that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant "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 "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 is: [unsecured, getResponse, pagableRequest] /organization/registration/topOrganization/packages: description: collection endpoint for package resources is: [unsecured] get: description: "Performs a search for packages. [Since:1.0][Flow-name:service-search-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: id: description: Filter the search results by the given id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve only packages with the specified name. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve only packages with the specified description. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false category: description: Retrieve only packages assigned to the given category. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false parentService.id: description: Retrieve services that are children of the given parent service id. Multiple parameters are supported in which case retrieval of children services of all specified parent services will be performed. Note that this only includes immediate children, and not grandchildren or deeper. type: string required: false repeat: false owningOrganization.id: description: Return all packages owned by the given organization id. Multiple parameters are supported, which will return packages that are owned by any of the given organizations. type: string required: false repeat: false parentPackage.id: description: Return all children packages of the given parent package. Multiple parameters are supported, which will return child packages of all given parent packages. type: string required: false repeat: false grantable: description: Return all packages that are flagged as grantable. type: boolean required: false repeat: false requestable: description: Return all packages that are flagged as requestable. type: boolean required: false repeat: false sortBy: description: Sort the search results according to creation timestamp property. type: string required: false repeat: false enum: [+creation, "-creation"] 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.v1+json: schema: package "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 the client's request ___ Substatus codes are mentioned below: + 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} + search.packages.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /organization/requests: description: Collection endpoint for organization registration request resources. is: [secured] get: description: "Searches organization requests resources according to the filter criteria. [Since:1.1][Flow-name:registration-search-organization-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.v1+json Content-Type: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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: registrant.id: description: The id of the organization. type: string required: false repeat: false organization.id: description: The id of the registrant. type: string required: false repeat: false organizationName: description: The name of the organization. Wild card search is supported. Multi value search not supported. type: string required: false repeat: false responses: "200": description: All matching person request resources were successfully retrieved.. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: request "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 "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] post: description: "Creates a new organization request, person request for registrant, service package requests for provided packages if any. [Since:1.1][Flow-name:registration-create-organization-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.v1+json Content-Type: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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 body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: request responses: "201": description: A new organization registration was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: request "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 organization request. uriParameters: requestId: description: Unique identifier of the organization request type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "Returns a organization request by id. [Since:1.0][Flow-name:registration-get-organization-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.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 organization request was successfully retrieved. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: request "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] /tasks/approve: description: Approve an organization request, activate the organization, and approve the person request and activate the person, and grant the exchange service package id, and grant the requested packages. is: [secured] post: description: "Approve an organization request, activate the organization, and approve the person request and activate the person, and grant the exchange service package id, and grant the requested packages. [Since:1.1][Flow-name:registration-task-approve-organization-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 queryParameters: requestId: description: The unique identifier of the organization 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 approved. The organization 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:header:missing - Missing request header: {headerName} + 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. + organization.request.multiple.requestIds.not.allowed - Multiple requestIds are 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 "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 organization request as well as deny the person request, requested packages and exchange package id. is: [secured] post: description: "It will deny the organization request as well as deny the person request, requested packages and exchange package id.[Since:1.1][Flow-name:registration-task-deny-organization-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 queryParameters: requestId: description: The unique identifier of the organization 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. + organization.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] /registrations: /securedInvite/initiate: description: Get the person's secured invitation. is: [unsecured] /{id}: uriParameters: id: description: The base64 encoded string of inviteId and invitation pin. type: string required: true repeat: false maxLength: 36 is: [unsecured] get: description: "Get the secured person invitation based on encoded inviteId and invitation pin.[Since:1.1][Flow-name:registration-get-person-secured-invitation]" headers: Accept: description: The media type to write the response body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.invitation.v1+json SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: A new person invitation was created and is returned in the response body and the new nonce created and send as a response header. body: application/vnd.com.covisint.platform.person.invitation.v1+json: schema: personInvitation headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 are mentioned below: + framework:request + framework:request:header:missing - Missing request header: {headerName} + 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] /open/initiate: description: The person's open invitation, authentication not required, but in the response you will receive the nonce as a header. is: [unsecured] get: description: "The person's open invitation.[Since:1.1][Flow-name:registration-get-open-person-invitation]" headers: SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: Successfully return the open person invitation, and the nonce to return. headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 are mentioned below: + framework:request + framework:request:header:missing - Missing request header: {headerName} + 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] /organizations: description: Collection endpoint for organization resources using nonce validation. is: [unsecured] get: description: "Performs a search for organization resources.[Since:1.1][Flow-Name:registration-search-organizations]" headers: Accept: description: The media type to write the response body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: name: description: Retrieve only organizations with the specified name. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false parentOrganization.id: description: Retrieve the organizations with the specified parent organization id. type: string required: false repeat: false rootOrganization.id: description: Retrieve the organizations with the specified root organization id. type: string required: false repeat: false status: description: Retrieve the organizations with the specified status example. Examples {active, pending, inactive, suspended}. 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 organizations that satisfy the query parameters were successfully retrieved(if flag getextendedattributes sets to true then organizations should return the extended attributes if any in the response) (response collection may be empty). body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 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 is: [unsecured, getSearchResponse, pagableRequest] /{id}: description: Individual resource endpoint for organization resources, which requires the nonce validation. uriParameters: id: description: The unique organization identifier. type: string required: true repeat: false maxLength: 36 is: [secured] get: description: "The retreive the organization by id, and it gets the nonce validation. [Since:1.0][Flow-Name:registration-get-organization]" headers: Accept: description: The media type to write the response body. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 organization was successfully retrieved, and it will return the new nonce. body: application/vnd.com.covisint.platform.organization.v1+json: schema: organization headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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: [unsecured, getResponse] /count: description: Count endpoint for organization resources. is: [unsecured] get: description: "Returns the count of organizations.[Since:1.3][Flow-Name:registration-count-organizations]" headers: Accept: description: Used to request the appropriate organization resource media type. type: string required: true repeat: false example: text/plain Nonce: description: it is a token for validation of nonce for application endpoints. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: name: description: Retrieve only organizations with the specified name. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false parentOrganization.id: description: Retrieve the organizations with the specified parent organization id. type: string required: false repeat: false rootOrganization.id: description: Retrieve the organizations with the specified root organization id. type: string required: false repeat: false responses: "200": description: The total number of organizations successfully retrieved. body: text/plain: headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 is: [unsecured] /securityQuestions: description: Endpoint for security questions used to verify a person's account, and this api will be validated with nonce. is: [unsecured] get: description: "Search for available security questions. If the owner query parameters are not specified, then all available security questions will be returned. [Since:1.1][Flow-name:registration-search-securityquestions]" headers: Accept: description: Media type for a security question resource. type: string required: true repeat: false example: application/vnd.com.covisint.platform.securityquestion.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: owner.id: description: Filter on the id of the resource owning the question. For example, the person id or organization id. This query parameter is only required if owner.type is specified. type: string required: false repeat: false owner.type: description: Filter on the type of the resource owning the question. For example, person or organization. This query paramer is only required if owner.id is specified. 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 security questions were successfully retrieved. body: application/vnd.com.covisint.platform.securityquestion.v1+json: schema: securityQuestions headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 the client's request ___ Substatus codes and error messages are mentioned below: + framework:request + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + framework:request:param:missing - Missing request parameter: {queryParameterName} + securityquestions.multiple.owner.id.invalid - Muliple owner ids {ownerId(s)} are not allowed + securityquestions.multiple.owner.type.invalid - Muliple owner types {ownerId(s)} are not allowed + securityquestions.owner.id.invalid - Owner id {ownerId} invalid if owner type is not mentioned + securityquestions.owner.type.invalid - Owner type {ownerType} invalid if owner id is not mentioned + 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 is: [unsecured, getSearchResponse, pagableRequest] /organizations/{organizationId}/packages: description: Collection endpoint for organization package grant resources, which requires the validates the nonce. uriParameters: organizationId: description: The id of the organization for whom this grant is being made. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for an organization's package grants, which requires the validates the nonce.[Since:1.1][Flow-Name:registration-search-organization-packages]" headers: Accept: description: The media type for the package grants. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes. nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 package grants that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json;includeCodes: schema: packageGrant headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 "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 is: [unsecured, getResponse, pagableRequest] /attributes/{id}: description: Individual endpoint for an attribute, which requires the nonce validation. uriParameters: id: description: Unique identifier of the attribute. type: string required: true repeat: false maxLength: 64 is: [secured] get: description: "Retreives the attribute by id, which requires the nonce validation.[Since:1.1][Flow-Name:registration-get-attribute]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.attribute.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 attribute was successfully retrieved, and it will return the new nonce. body: application/vnd.com.covisint.platform.attribute.v1+json: schema: attribute headers: nonce: description: The newly created nonce. type: string required: true repeat: false "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + 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: [unsecured, getResponse] /attributeTemplates: description: Collection endpoint for attribute templates, which requires the nonce validation. is: [unsecured] get: description: "Search attribute templates based on the given filter parameters, which requires the nonce validation.[Since:1.1][Flow-name:registration-search-attribute-templates]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.attribute.template.v1+json; nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: name: description: Retrieve only attribute templates with the specified name of the attribute template. The search is case-insensitive. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false attributes.id: description: Retrieve only attribute templates with the specified attribute unique identifier of the attribute. The search is case-insensitive. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false sortBy: description: Sort the search results according to the supported sortable properties. type: string required: false repeat: false enum: [+creation, "-creation"] 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 attribute templates that satisfy the query parameters were successfully retrieved (response collection may be empty), and the newly created nonce. body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplates headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + 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: [unsecured, getSearchResponse, pagableRequest] /{id}: description: Individual endpoint for an attribute template, which requires the nonce validation. uriParameters: id: description: Unique identifier of the attribute template. type: string required: true repeat: false maxLength: 64 is: [secured] get: description: "Retreives the attribute template by id, which requires the nonce validation.[Since:1.1][Flow-Name:registration-get-attribute-template]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.attribute.template.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 attribute template was successfully retrieved, and the newly created nonce. body: application/vnd.com.covisint.platform.attribute.template.v1+json: schema: attributeTemplate headers: nonce: description: The newly created nonce. type: string required: true repeat: false "400": description: | There was a problem with the client's request ___ Substatus codes and error messages are mentioned below: + framework:request:io:write + framework:request:header:missing - Missing request header: {headerName} + 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: [unsecured, getResponse] /packages: description: collection endpoint for package resources, which requires the nonce validation is: [unsecured] get: description: "Performs a search for packages, if nonce is valid. [Since:1.1][Flow-name:registration-search-packages]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: id: description: Filter the search results by the given id. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false name: description: Retrieve only packages with the specified name. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false claimId: description: Retrieve only packages with the specified claimId. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false claimValueId: description: Retrieve only packages with the specified claimValueId. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false description: description: Retrieve only packages with the specified description. The search is case-insensitive and looks at all available languages. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false category: description: Retrieve only packages assigned to the given category. The search is case-insensitve. Multiple parameters are supported and the search results will be a union. type: string required: false repeat: false owningOrganization.id: description: Return all packages owned by the given organization id. Multiple parameters are supported, which will return packages that are owned by any of the given organizations. type: string required: false repeat: false parentPackage.id: description: Return all children packages of the given parent package. Multiple parameters are supported, which will return child packages of all given parent packages. type: string required: false repeat: false grantable: description: Return all packages that are flagged as grantable. type: boolean required: false repeat: false requestable: description: Return all packages that are flagged as requestable. type: boolean required: false repeat: false sortBy: description: Sort the search results according to creation timestamp property. type: string required: false repeat: false enum: [+creation, "-creation"] 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 packages that satisfy the query parameters were successfully retrieved (response collection may be empty), and it will return the new nonce. body: application/vnd.com.covisint.platform.package.v1+json: schema: package headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 the client's request ___ Substatus codes are mentioned below: + 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} + search.packages.request.invalid.combination.queryParamaters - Multiple {queryParameter} are not allowed. body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getSearchResponse, pagableRequest] /persons: /password/validate: description: "collection endpoint to validate password against policy resources retrieved by using InviteId and orgnizationId.[Since:1.1]" is: [unsecured] post: description: "collection endpoint to validate password against policy resources retrieved by using InviteId and orgnizationId.[Flow-name:registration-validate-password]" 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 nonce: description: it is a token for validation of nonce for application endpoints. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c 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 headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 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 is: [postResponse] /registration: description: Endpoint for registering a user, if provided nonce is valid. 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", and which requires the nonce validation.[Since:1.1][Flow-name:registration-register-person]' headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.password.account.v1+json Content-Type: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.password.account.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false 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, it will return the new nonce. body: application/vnd.com.covisint.platform.person.password.account.v1+json: schema: personPasswordAccount headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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] /validate: description: Endpoint for validating email address and/or user name, if the provided nonce is valid. is: [unsecured] post: description: | Validate the email address and/or user name exists. Email address and/or user name provides as parameters.[Since:1.1][Flow-name:registration-validate-registration] headers: nonce: description: The nonce to authenticate. type: string required: true repeat: false 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 headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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] /{personId}: description: "view User Profile , if the provided nonce is valid.[Since:1.5][Flow-name:registration-get-person-registration]" uriParameters: personId: description: global covisint user Id. type: string required: true repeat: false maxLength: 36 is: [unsecured] get: description: "Retreives the User Profile by its id, if the nonce is valid.parameters.[Since:1.5][Flow-name:registration-get-person]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The User Profile was successfully retrieved, and it will return the nonce. body: application/vnd.com.covisint.platform.person.v1+json: schema: person headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 "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 is: [getResponse, unsecured] /passwords/policies/{id}: description: individual resource endpoint for password policy, if the provided nonce is valid. uriParameters: id: description: Unique identifier of the password policy. type: string required: true repeat: false maxLength: 36 is: [unsecured] get: description: "Retreives the password policy by its id, if the nonce is valid.[Flow-Name:registration-get-password-policy][Since:1.1][Flow-name:registration-get-password-policy]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.password.policy.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The password policy was successfully retrieved, and it will return the nonce. body: application/vnd.com.covisint.platform.password.policy.v1+json: schema: passwordPolicy headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 "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 is: [getResponse, unsecured] /persons/requests: description: Collection endpoint for person registration request resources, if the nonce is valid. is: [unsecured] post: description: "Creates a new person request, service package requests if any, and if nonce is valid. [Since:1.1][Flow-name:registration-unsecured-create-person-request]" headers: Accept: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json Content-Type: description: Media type for person request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.person.request.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false 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.request.v1+json: schema: request 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: request headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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] + framework:resource:missing - The following resources were not found: {resources} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, unsecured] /packages/{packageId}/persons/tacs: description: collection endpoint for package's terms and condition resources pertinent to person. uriParameters: packageId: displayName: packageId type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to person.[Since:1.2][Flow-Name:registration-unsecured-search-terms-and-condition-person]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The package's terms and condition pertinent to person returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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 "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] + framework:request:exception:during:retrieval:tac:pertinent:to:person - Exception occured during retrieve the Package's terms and condition pertinent to person {resourceFieldName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /languages/{languageId}: description: individual resource endpoint for package's terms and condition pertinent to person by language. uriParameters: languageId: description: The language of the package's terms and condition pertinent to person. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to person by language.[Since:1.2][Flow-Name:registration-unsecured-search-terms-and-condition-person-by-language]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The package's terms and condition pertinent to person by language returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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 "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] + framework:request:exception:during:retrieval:tac:pertinent:to:person - Exception occured during retrieve the Package's terms and condition pertinent to person {resourceFieldName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /packages/{packageId}/organizations/tacs: description: collection endpoint for package's terms and condition resources pertinent to organization. uriParameters: packageId: displayName: packageId type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to organization.[Since:1.2][Flow-Name:registration-unsecured-search-terms-and-condition-organization]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The package's terms and condition pertinent to organization returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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 "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] + framework:request:exception.during.retrieval.tac.pertinent.to.organization - Exception occured during retrieve the Package's terms and condition pertinent to organization {resourceFieldName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /languages/{languageId}: description: individual resource endpoint for package's terms and condition pertinent to organization by language. uriParameters: languageId: description: The language of the package's terms and condition pertinent to organization. type: string required: true repeat: false is: [unsecured] get: description: "Performs a search for package's terms and condition resources pertinent to organization by language.[Since:1.2][Flow-Name:registration-unsecured-search-terms-and-condition-organization-by-language]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c responses: "200": description: The package's terms and condition pertinent to organization by language returns successfully. body: application/vnd.com.covisint.platform.package.terms.and.condition.v1+json: schema: termsAndCondition "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 "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] + framework:request:exception.during.retrieval.tac.pertinent.to.organization - Exception occured during retrieve the Package's terms and condition pertinent to organization {resourceFieldName} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [getResponse] /registrations/organizations/requests: description: Collection endpoint for organization registration request resources. is: [unsecured] post: description: "Creates a new organization request, person request for registrant, service package requests for provided packages if any. [Since:1.1][Flow-name:unified-create-organization-request]" headers: Accept: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.v1+json Content-Type: description: Media type for organization request. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.request.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.organization.request.v1+json: schema: request responses: "201": description: A new organization registration was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.request.v1+json: schema: request "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] + framework:resource:missing - The following resources were not found: {resources} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [postResponse, unsecured] /registrations/organizationInvitations: /company: description: Organization Invite for Top Company. is: [unsecured] post: description: "Creates a new Organization Invitation for top-company.[Since:1.1][Flow-name:organization-create-topcompanyinvitation]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.invitation.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.organization.invitation.v1+json: schema: organizationInvitation responses: "201": description: A new organization invitation for the top company was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.invitation.v1+json: schema: organizationInvitation "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 "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 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} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [taskResponse] /division: description: Organization Invite for the Division. is: [unsecured] post: description: "Creates a new Organization Invitation for the division.[Since:1.1][Flow-name:organization-create-divisioninvitation]" headers: Accept: description: Media type for person invitation. type: string required: true repeat: false example: application/vnd.com.covisint.platform.organization.invitation.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.organization.invitation.v1+json: schema: organizationInvitation responses: "201": description: A new organization invitation for the top company was created and is returned in the response body. body: application/vnd.com.covisint.platform.organization.invitation.v1+json: schema: organizationInvitation "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 "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 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} body: application/vnd.com.covisint.error.v1+json: schema: errorResponseSchema is: [taskResponse] /registrations/grants: description: "Search endpoint for package grants. [Since:1.1]" is: [unsecured] get: description: "Performs a search for all grants of the specified package id if nonce is valid. [Since:1.1][Flow-name:registration-service-search-grants]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.package.grant.v1+json nonce: description: The nonce to authenticate. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: grantedPackageId: description: the id of the granted package which is being searched. type: string required: true repeat: false granteeType: description: The type of grantee to be filtered. Omit this parameter to retrieve grants for all grantees. type: string required: false repeat: false enum: [person, organization] 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 package grants that satisfy the search criteria were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.package.grant.v1+json: schema: packageGrant "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 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 is: [getSearchResponse, pagableRequest] /applications/organizations/{organizationId}: description: "individual resource endpoint for application resources for an organization.[Since:1.3]" uriParameters: organizationId: description: The id of the organization for whose this request is being made. type: string required: true repeat: false is: [unsecured] get: description: "Retrieve applications that are granted to the organization.[Flow-name:registration-get-organization-granted-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/vnd.com.covisint.platform.service.application.v1+json Nonce: description: it is a token for validation of nonce for application endpoints. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false sortBy: description: Sort the search results. type: string required: false repeat: false enum: [+service.name, "-service.name", +service.creation, "-service.creation", +grant.instant, "-grant.instant"] 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 applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: application/vnd.com.covisint.platform.service.application.v1+json: schema: application headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 "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] + 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 is: [getSearchResponse, pagableRequest, getResponse] /count: description: "Count applications that are granted to organization.[Since:1.3]" is: [unsecured] get: description: "Count applications that are granted to the organization.[Flow-name:registration-count-organization-granted-applications]" headers: Accept: description: Media type. type: string required: true repeat: false example: text/plain Nonce: description: it is a token for validation of nonce for application endpoints. type: string required: true repeat: false SolutionInstanceId: description: The solution instance id. type: string required: true repeat: false example: abcd123e-0109-441c-8a20-123a456b789c queryParameters: service.id: description: Filter the search results by the given id. type: string required: false repeat: false service.category: description: Filter the search results by the given category. type: string required: false repeat: false service.name: description: Filter the search results by the given name. type: string required: false repeat: false servicePackage.id: description: Filter the search results by the given service packageId. type: string required: false repeat: false servicePackage.parentPackage.id: description: Filter the search results by the given parent packageId. type: string required: false repeat: false grant.status: description: Filter the search results by the given grant status. type: string required: false repeat: false responses: "200": description: All applications that satisfy the query parameters were successfully retrieved (response collection may be empty). body: text/plain: headers: nonce: description: The newly created nonce. type: string required: true repeat: false "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 "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] + 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 is: [getSearchResponse, getResponse] /packages/{packageId}/services: description: collection endpoints for the services that are members of this package. uriParameters: packageId: displayName: packageId type: string required: true repeat: false is: [unsecured]