#%RAML 0.8 title: SCIM API baseUri: "https://apistg.np.covapp.io/scim/v2" protocols: [HTTPS] schemas: - commonAttributes: | { "id" : "http://api.covisint.com/idm/schema/commonAttributes", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Attributes common for all SCIM resources.", "properties" : { "schemas" : { "description" : "Array of schemas supported.", "type" : "array", "minItems": 1, "items": { "type" : "string" } }, "id" : { "description" : "A unique identifier for a SCIM resource as defined by the service provider.", "type" : "string" }, "externalId" : { "description" : "A String that is an identifier for the resource as defined by the provisioning client.", "type" : "string" }, "meta" : { "description" : "A complex attribute containing resource metadata. All 'meta' sub-attributes are assigned by the service provider", "type" : "object", "properties" : { "resourceType" : { "description" : "The name of the resource type of the resource.", "type" : "string" }, "created" : { "description" : "The 'DateTime' that the resource was added to the service provider.", "type" : "string" }, "lastModified" : { "description" : "The most recent DateTime that the details of this resource were updated at the service provider.", "type" : "string" }, "location" : { "description" : "The URI of the resource being returned.", "type" : "string" }, "version" : { "description" : "The version of the resource being returned.", "type" : "string" } } } } } - listResponse: | { "id" : "http://api.covisint.com/idm/schema/listResponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Describes the list of resources returned in response.", "properties" : { "schemas" : { "description" : "List response schema is 'urn:ietf:params:scim:api:messages:2.0:ListResponse'", "type" : "array", "minItems": 1, "items": { "type" : "string" } }, "totalResults" : { "description" : "The total number of results returned by the list or query operation.", "type" : "integer" }, "startIndex" : { "description" : "The 1-based index of the first result in the current set sof list results.", "type" : "integer" }, "itemsPerPage" : { "description" : "The number of resources returned in a list response page.", "type" : "integer" } } } - user: | { "id" : "http://api.covisint.com/idm/schema/user", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "User resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/commonAttributes#" }, "properties" : { "userName" : { "description" : "Unique identifier for the User. This identifier MUST be unique across the service provider's entire set of Users.", "type" : "string" }, "name" : { "type" : "object", "description" : "The components of the user's real name.", "properties" : { "familyName" : { "description" : "The family name of the User, or last name in most Western languages (e.g., 'Jensen' given the full name 'Ms. Barbara J Jensen, III').", "type" : "string" }, "givenName" : { "description" : "The given name of the User, or first name in most Western languages (e.g., 'Barbara' given the full name 'Ms. Barbara J Jensen, III').", "type" : "string" }, "middleName" : { "description" : "The middle name(s) of the User (e.g., 'Jane' given the full name 'Ms. Barbara J Jensen, III').", "type" : "string" }, "honorificPrefix" : { "description" : "The honorific prefix(es) of the User, or title in most Western languages (e.g., 'Ms.' given the full name 'Ms. Barbara J Jensen, III').", "type" : "string" }, "honorificSuffix" : { "description" : "The honorific suffix(es) of the User, or suffix in most Western languages (e.g., 'III' given the full name 'Ms. Barbara J Jensen, III').", "type" : "string" } } }, "title" : { "description" : "The user's title, such as 'Vice President.'", "type" : "string" }, "preferredLanguage" : { "description" : "Indicates the User's preferred written or spoken language. ", "type" : "string" }, "timezone" : { "description" : "The User's time zone in the 'Olson' time zone database format, e.g., 'America/Los_Angeles'.", "type" : "string" }, "active" : { "description" : "A Boolean value indicating the User's administrative status.", "type" : "boolean" }, "emails" : { "type" : "array", "description" : "Email addresses for the user. Canonical type values of 'work', 'home', and 'other'.", "minItems": 0, "items": { "type": "object", "properties": { "value" : { "description" : "Email addresses for the user.", "type" : "string" }, "primary" : { "description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute.", "type" : "boolean" } } } }, "phoneNumbers" : { "type" : "array", "description" : "Phone numbers for the User. Canonical type values of 'work', 'home', 'mobile', 'fax', 'pager', and 'other'.", "minItems": 0, "items": { "type": "object", "properties": { "value" : { "description" : "Phone number of the User.", "type" : "string" }, "type" : { "description" : "A label indicating the attribute's function, e.g., 'work', 'home', 'mobile'.", "type" : "string" }, "primary" : { "description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute.", "type" : "boolean" } } } }, "addresses" : { "type" : "array", "description" : "A physical mailing address for this User. Canonical type values of 'work', 'home', and 'other'. ", "minItems": 0, "items": { "type": "object", "properties": { "formatted" : { "description" : "The full mailing address, formatted for display or use with a mailing label. This attribute MAY contain newlines.", "type" : "string" }, "streetAddress" : { "description" : "The full street address component, which may include house number, street name, P.O. box, and multi-line extended street address information. This attribute MAY contain newlines.", "type" : "string" }, "locality" : { "description" : "The city or locality component.", "type" : "string" }, "region" : { "description" : "The state or region component.", "type" : "string" }, "postalCode" : { "description" : "The zip code or postal code component.", "type" : "string" }, "country" : { "description" : "The country name component.", "type" : "string" }, "primary" : { "description" : "A Boolean value indicating the 'primary' or preferred attribute value for this attribute, e.g., the preferred mailing address. ", "type" : "boolean" } } } }, "groups" : { "type" : "array", "description" : "A list of groups to which the user belongs, either through direct membership, through nested groups, or dynamically calculated.", "minItems": 0, "items": { "type": "object", "properties": { "value" : { "description" : "The identifier of the User's group.", "type" : "string" }, "$ref" : { "description" : "The URI of the corresponding 'Group' resource to which the user belongs.", "type" : "string" } } } }, "urn:ietf:params:scim:schemas:extension:covisint:2.0:User" : { "description" : "Covisint user resource.", "$ref" : "http://api.covisint.com/idm/schema/covisintUser" } }, "required" : [ "userName" ] } - users: | { "id" : "http://api.covisint.com/idm/schema/users", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "List of users returned in response.", "extends" : { "$ref" : "http://api.covisint.com/schema/listResponse#" }, "Resources" : { "description" : "Array of users.", "type" : "array", "minItems": 0, "items": { "type": "object", "$ref" : "http://api.covisint.com/idm/schema/user#" } } } - covisintUser: | { "id" : "http://api.covisint.com/idm/schema/covisintUser", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Covisint user resource.", "extends" : { "$ref" : "http://api.covisint.com/schema/commonAttributes#" }, "properties" : { "belongsToOrganizationId" : { "description" : "Covisint Organization id to which a user belongs to. Cannot be changed during a PATCH/PUT. Needs to be set during a POST.", "type" : "integer" }, "attributesTemplateName" : { "description" : "Name of attribute template to use.", "type" : "string" }, "extendedAttributes" : { "type" : "array", "description" : "Additional attributes which map to Covisint attributes", "minItems": 0, "items": { "type": "object", "properties": { "name" : { "description" : "Attribute name having covisint attribute id.", "type" : "string" }, "value" : { "description" : "Attribute value.", "type" : "string" } }, "required" : [ "name" ] } } } } - errorResponse: | { "id" : "http://api.covisint.com/idm/schema/errorResponse", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Error Response.", "properties" : { "schemas" : { "description" : "Error schema is 'urn:ietf:params:scim:api:messages:2.0:Error'", "type" : "array", "minItems": 1, "items": { "type" : "string" } }, "status" : { "description" : "The HTTP status code.", "type" : "string" }, "scimType" : { "description" : "A SCIM detail error keyword.", "type" : "string" }, "detail" : { "description" : "A detailed human-readable message.", "type" : "string" } }, "required" : [ "status" ] } - group: | { "id" : "http://api.covisint.com/idm/schema/group", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing group.", "properties" : { "displayName" : { "description" : "A human-readable name for the Group. REQUIRED.", "type" : "string" }, "members" : { "description" : "A list of members of the Group.", "type" : "array", "items" : { "type" : "object", "properties" : { "value" : { "description" : "Identifier of the member of this Group.", "type" : "string" }, "$ref" : { "description" : "The URI corresponding to a SCIM resource that is a member of this Group.", "type" : "string" }, "type" : { "description" : "A label indicating the type of resource, e.g., 'User' or 'Group'.", "type" : "string" } } } } }, "required" : [ "displayName" ] } - groups: | { "id" : "http://api.covisint.com/idm/schema/groups", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "List of groups returned in response.", "extends" : { "$ref" : "http://api.covisint.com/schema/listResponse#" }, "Resources" : { "description" : "Array of groups.", "type" : "array", "minItems": 0, "items": { "type": "object", "$ref" : "http://api.covisint.com/idm/schema/group#" } } } - patchRequest: | { "id" : "http://api.covisint.com/idm/schema/patchRequest", "$schema" : "http://json-schema.org/draft-04/schema", "type" : "object", "description" : "Schema representing PATCH.", "properties" : { "schemas" : { "description" : "PATCH Schema is 'urn:ietf:params:scim:api:messages:2.0:PatchOp'", "type" : "array", "minItems": 1, "items": { "type" : "string" } }, "Operations" : { "description" : "The array of the operations to be executed as a part of the PATCH.", "type" : "array", "items" : { "type" : "object", "properties" : { "op" : { "description" : "The operation to be performed.", "type" : "string", "enum" : [ "add", "replace", "remove" ] }, "path" : { "description" : "The path to the sub-attribute to be modified.", "type" : "string" }, "value" : { "description" : "The new value of the sub-attribute", "type" : "object" } } } } } } traits: - secured: displayName: secured - filterable: displayName: filterable - allErrorsSupportable: displayName: allErrorsSupportable - resourceErrorConflictable: displayName: resourceErrorConflictable /Users: get: description: "Returns the list of users in the realm. [Since:1.0][flow-name:scim-get-users]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+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: filter: description: | Filter by field: userName eq 'abc', or emails[value eq 'abc@abc.com'], or urn:ietf:params:scim:schemas:extension:covisint:2.0:User.extendedAttributes[name eq 'someName'], or urn:ietf:params:scim:schemas:extension:covisint:2.0:User.extendedAttributes[value eq 'someValue'] type: string required: false repeat: false responses: "200": description: Matching users retrieved successfully. body: application/scim+json: schema: users "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable, filterable] post: description: "Create User resource. [Since:1.0][flow-name:scim-post-users]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+json Content-Type: description: Media type. type: string required: true repeat: false example: application/scim+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/scim+json: schema: user responses: "201": description: JSON structure that describes the user resource created. body: application/scim+json: schema: user "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse "409": description: The creation of the requested resource conflicts with existing resources. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable, resourceErrorConflictable] /{id}: uriParameters: id: displayName: id type: string required: true repeat: false get: description: "Get User resource based on id. [Since:1.0][flow-name:scim-get-users-id]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+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: JSON structure that describes the user resource. body: application/scim+json: schema: user "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] put: description: "Replace User resource. [Since:1.0][flow-name:scim-put-users-id]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+json Content-Type: description: Media type. type: string required: true repeat: false example: application/scim+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/scim+json: schema: user responses: "200": description: JSON structure that describes the user resource replaced. body: application/scim+json: schema: user "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse "409": description: The creation of the requested resource conflicts with existing resources. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable, resourceErrorConflictable] /Groups: description: Collection endpoint for groups. get: description: "Returns the list of groups in the realm. [Since:1.0][flow-name:scim-get-groups]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+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: filter: description: | Filter by field: displayName type: string required: false repeat: false responses: "200": description: Matching groups retrieved successfully. body: application/scim+json: schema: groups "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable, filterable] post: description: "Creates a group. [Since:1.0][flow-name:scim-post-groups]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+json Content-Type: description: Media type. type: string required: true repeat: false example: application/scim+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/scim+json: schema: group responses: "201": description: A new group is created successfully. body: application/scim+json: schema: group "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /{id}: uriParameters: id: displayName: id type: string required: true repeat: false get: description: "Get group resource based on id. [Since:1.0][flow-name:scim-get-groups-id]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+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: JSON structure that describes the group resource. body: application/scim+json: schema: group "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] delete: description: "Delete group resource based on id. [Since:1.0][flow-name:scim-delete-groups-id]" headers: Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "204": description: JSON structure that describes the group resource. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] patch: description: "Updates a group. [Since:1.0][flow-name:scim-patch-groups-id]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/scim+json Content-Type: description: Media type. type: string required: true repeat: false example: application/scim+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/scim+json: schema: patchRequest responses: "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /ClientConfiguration: description: Collection end point for client configurations. get: description: "Returns the list of client configurations in the realm. [Since:1.0][flow-name:scim-get-clientconfigurations]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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: Matching groups retrieved successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] post: description: "Creates client configuration. [Since:1.0][flow-name:scim-post-clientconfigurations]" headers: Content-Type: description: Media type. type: string required: true repeat: false example: application/json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: New client configuration is created successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /{id}: uriParameters: id: displayName: id type: string required: true repeat: false get: description: "Get clientconfiguration based on client Id. [Since:1.0][flow-name:scim-get-clientconfigurations-id]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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: Retrieved clientconfiguration successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /ConnectorConfiguration: description: Collection end point for SCIM Connector Configurations. get: description: "Returns the list of SCIM Connector Configurations in the realm. [Since:1.0][flow-name:scim-get-connector-configurations]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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: Retrieved SCIM Connector Configurations successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] post: description: "Adds a list of SCIM Connector Configurations. [Since:1.0][flow-name:scim-add-connector-configurations]" headers: Content-Type: description: Media type. type: string required: true repeat: false example: application/json Authorization: description: Access token that is obtained from the /token endpoint of the OAuth API. type: string required: true repeat: false pattern: "^Bearer .*$" example: Bearer ZCtYUGpYRXpET0JvVE1rZzlWV3I1Yk responses: "201": description: Added SCIM Connector Configurations successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /{id}: uriParameters: id: displayName: id type: string required: true repeat: false put: description: "Update SCIM Connector Configuration. [Since:1.0][flow-name:scim-put-connector-configuration]" headers: Content-Type: description: Media type. type: string required: true repeat: false example: application/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: Updated SCIM Connector Configuration successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] delete: description: "Delete SCIM Connector Configuration. [Since:1.0][flow-name:scim-delete-connector-configuration]" 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: Deleted SCIM Connector Configuration successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /activate: post: description: "Activates SCIM Connector Configuration. [Since:1.0][flow-name:scim-activate-connector-configuration]" 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: "201": description: Activates SCIM Connector Configuration successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /deactivate: post: description: "Deactivates SCIM Connector Configuration. [Since:1.0][flow-name:scim-deactivate-connector-configuration]" 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: "201": description: Deactivates SCIM Connector Configuration successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable] /{eventName}: uriParameters: eventName: displayName: eventName type: string required: true repeat: false get: description: "Returns the list of SCIM Connector Configurations in the realm for the given event. [Since:1.0][flow-name:scim-get-connector-configurations-event]" headers: Accept: description: Media type. type: string required: true repeat: false example: application/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: Retrieved SCIM Connector Configurations for given event successfully. "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/scim+json: schema: errorResponse "403": description: Unauthorized request. The requestor is not authorized to perform the requested operation. body: application/scim+json: schema: errorResponse "307": description: The client is directed to repeat the same HTTP request at the location identified. The location is NOT a permanent reference to the resource. body: application/scim+json: schema: errorResponse "308": description: The client is directed to repeat the same HTTP request at the location identified. The location is a permanent reference to the resource. body: application/scim+json: schema: errorResponse "400": description: Request is unparsable, syntactically incorrect, or violates schema. body: application/scim+json: schema: errorResponse "404": description: Specified resource (e.g., User) or endpoint does not exist. body: application/scim+json: schema: errorResponse "500": description: An internal error. Implementers SHOULD provide descriptive debugging advice. body: application/scim+json: schema: errorResponse "501": description: Service provider does not support the request operation, e.g., PATCH. body: application/scim+json: schema: errorResponse is: [secured, allErrorsSupportable]