swagger: '2.0' info: description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more. version: v2 title: PureCloud Platform Agent Assistants SCIM API termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/ contact: name: PureCloud Developer Evangelists url: https://developer.genesys.cloud/ email: DeveloperEvangelists@genesys.com license: name: UNLICENSED url: https://help.genesys.cloud/articles/terms-and-conditions/ host: api.mypurecloud.com schemes: - https consumes: - application/json produces: - application/json tags: - name: SCIM description: System for Cross-domain Identity Management externalDocs: description: 'System for Cross-domain Identity Management: Definitions, Overview, Concepts, and Requirements' url: https://developer.genesys.cloud/useragentman/scim/scim-apis paths: /api/v2/scim/resourcetypes/{resourceType}: get: tags: - SCIM summary: Get a resource type description: '' operationId: getScimResourcetype consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: resourceType in: path description: The type of resource. Returned with GET /api/v2/scim/resourcetypes. required: true type: string enum: - User - Group - ServiceProviderConfig - ResourceType - Schema responses: '200': description: successful operation schema: $ref: '#/definitions/ScimConfigResourceType' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimResourcetype /api/v2/scim/resourcetypes: get: tags: - SCIM summary: Get a list of resource types description: '' operationId: getScimResourcetypes consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ScimConfigResourceTypesListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimResourcetypes /api/v2/scim/schemas/{schemaId}: get: tags: - SCIM summary: Get a SCIM schema description: '' operationId: getScimSchema consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: schemaId in: path description: The ID of a schema. Returned with GET /api/v2/scim/schemas. required: true type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:core:2.0:Group - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig - urn:ietf:params:scim:schemas:core:2.0:ResourceType - urn:ietf:params:scim:schemas:core:2.0:Schema - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2SchemaDefinition' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimSchema /api/v2/scim/schemas: get: tags: - SCIM summary: Get a list of SCIM schemas description: '' operationId: getScimSchemas consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: filter in: query description: Filtered results are invalid and return 403 Unauthorized. required: false type: string x-example: displayName eq groupName responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2SchemaListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimSchemas /api/v2/scim/groups: get: tags: - SCIM summary: Get a list of groups description: '' operationId: getScimGroups consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: startIndex in: query description: The 1-based index of the first query result. required: false type: integer default: 1 format: int32 - name: count in: query description: The requested number of items per page. A value of 0 returns "totalResults". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the "excludedAttributes" or "attributes" query parameters to exclude or only include secondary lookup values such as "externalId", "roles", "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages", or "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills". required: false type: integer default: 25 format: int32 - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns "id", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: filter in: query description: 'Filters results. If nothing is specified, returns all groups. Examples of valid values: "id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3", "displayname eq Sales".' required: false type: string x-example: displayName eq groupName responses: '200': description: successful operation schema: $ref: '#/definitions/ScimGroupListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: getScimGroups /api/v2/scim/groups/{groupId}: get: tags: - SCIM summary: Get a group description: '' operationId: getScimGroup consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/groups. required: true type: string - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns "id", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '304': description: If-Non-Match header matches current version. No content returned. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: The requested resource was not found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: getScimGroup put: tags: - SCIM summary: Replace a group description: '' operationId: putScimGroup consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/groups. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to replace a group. required: true schema: $ref: '#/definitions/ScimV2Group' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: putScimGroup patch: tags: - SCIM summary: Modify a group description: '' operationId: patchScimGroup consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/groups. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to modify a group. required: true schema: $ref: '#/definitions/ScimV2PatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: patchScimGroup /api/v2/scim/serviceproviderconfig: get: tags: - SCIM summary: Get a service provider's configuration description: '' operationId: getScimServiceproviderconfig consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimServiceProviderConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimServiceproviderconfig /api/v2/scim/users/{userId}: get: tags: - SCIM summary: Get a user description: '' operationId: getScimUser consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/users. required: true type: string - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "userName", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns the "id", "userName", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '304': description: If-Non-Match header matches current version. No content returned. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' general.conflict: A conflict occurred when getting a SCIM user '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: The SCIM user was not found not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimUser put: tags: - SCIM summary: Replace a user description: '' operationId: putScimUser consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to replace a user. required: true schema: $ref: '#/definitions/ScimV2User' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: User could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:edit - directory:user:setPassword - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: putScimUser delete: tags: - SCIM summary: Delete a user description: '' operationId: deleteScimUser consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '204': description: User Deleted with no content returned. '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable general.conflict: Version does not match current version. '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:delete x-purecloud-method-name: deleteScimUser patch: tags: - SCIM summary: Modify a user description: '' operationId: patchScimUser consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to modify a user. required: true schema: $ref: '#/definitions/ScimV2PatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: User could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:edit - directory:user:setPassword - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: patchScimUser /api/v2/scim/users: get: tags: - SCIM summary: Get a list of users description: To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". To exclude these attributes, set the attributes parameter to "id,active" or the excludeAttributes parameter to "externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division". operationId: getScimUsers consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: startIndex in: query description: The 1-based index of the first query result. required: false type: integer default: 1 format: int32 - name: count in: query description: The requested number of items per page. A value of 0 returns "totalResults". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the "excludedAttributes" or "attributes" query parameters to exclude or only include secondary lookup values such as "externalId", "roles", "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages", or "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills". required: false type: integer default: 25 format: int32 - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "userName", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns the "id", "userName", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: filter in: query description: 'Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq search@sample.org", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq search@sample.org", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimUserListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). general.internal.server.error: An internal server error has occurred. '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimUsers post: tags: - SCIM summary: Create a user description: '' operationId: postScimUsers consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - in: body name: body description: The information used to create a user. required: true schema: $ref: '#/definitions/ScimV2CreateUser' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '201': description: User Created. schema: $ref: '#/definitions/ScimV2User' '409': description: User name already in use by non-deleted user. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:add - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: postScimUsers /api/v2/scim/v2/resourcetypes/{resourceType}: get: tags: - SCIM summary: Get a resource type description: '' operationId: getScimV2Resourcetype consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: resourceType in: path description: The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. required: true type: string enum: - User - Group - ServiceProviderConfig - ResourceType - Schema responses: '200': description: successful operation schema: $ref: '#/definitions/ScimConfigResourceType' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Resourcetype /api/v2/scim/v2/resourcetypes: get: tags: - SCIM summary: Get a list of resource types description: '' operationId: getScimV2Resourcetypes consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: [] responses: '200': description: successful operation schema: $ref: '#/definitions/ScimConfigResourceTypesListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Resourcetypes /api/v2/scim/v2/schemas/{schemaId}: get: tags: - SCIM summary: Get a SCIM schema description: '' operationId: getScimV2Schema consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: schemaId in: path description: The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. required: true type: string enum: - urn:ietf:params:scim:schemas:core:2.0:User - urn:ietf:params:scim:schemas:core:2.0:Group - urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig - urn:ietf:params:scim:schemas:core:2.0:ResourceType - urn:ietf:params:scim:schemas:core:2.0:Schema - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2SchemaDefinition' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Schema /api/v2/scim/v2/schemas: get: tags: - SCIM summary: Get a list of SCIM schemas description: '' operationId: getScimV2Schemas consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: filter in: query description: Filtered results are invalid and return 403 Unauthorized. required: false type: string x-example: displayName eq groupName responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2SchemaListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Schemas /api/v2/scim/v2/groups: get: tags: - SCIM summary: Get a list of groups description: '' operationId: getScimV2Groups consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: startIndex in: query description: The 1-based index of the first query result. required: false type: integer default: 1 format: int32 - name: count in: query description: The requested number of items per page. A value of 0 returns "totalResults". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the "excludedAttributes" or "attributes" query parameters to exclude or only include secondary lookup values such as "externalId", "roles", "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages", or "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills". required: false type: integer default: 25 format: int32 - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns "id", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: filter in: query description: 'Filters results. If nothing is specified, returns all groups. Examples of valid values: "id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3", "displayname eq Sales".' required: true type: string x-example: displayName eq groupName responses: '200': description: successful operation schema: $ref: '#/definitions/ScimGroupListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: getScimV2Groups /api/v2/scim/v2/groups/{groupId}: get: tags: - SCIM summary: Get a group description: '' operationId: getScimV2Group consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/v2/groups. required: true type: string - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns "id", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - displayName - members - externalId - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:id - urn:ietf:params:scim:schemas:core:2.0:Group:meta - urn:ietf:params:scim:schemas:core:2.0:Group:meta.version - urn:ietf:params:scim:schemas:core:2.0:Group:meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:Group:displayName - urn:ietf:params:scim:schemas:core:2.0:Group:members - urn:ietf:params:scim:schemas:core:2.0:Group:externalId collectionFormat: multi - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '304': description: If-Non-Match header matches current version. No content returned. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: getScimV2Group put: tags: - SCIM summary: Replace a group description: '' operationId: putScimV2Group consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/v2/groups. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to replace a group. required: true schema: $ref: '#/definitions/ScimV2Group' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: putScimV2Group patch: tags: - SCIM summary: Modify a group description: '' operationId: patchScimV2Group consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: groupId in: path description: The ID of a group. Returned with GET /api/v2/scim/v2/groups. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to modify a group. required: true schema: $ref: '#/definitions/ScimV2PatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2Group' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] org.disabled: Unable to modify group due to the organization being disabled. constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:group:edit x-purecloud-method-name: patchScimV2Group /api/v2/scim/v2/serviceproviderconfig: get: tags: - SCIM summary: Get a service provider's configuration description: '' operationId: getScimV2Serviceproviderconfig consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. ' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimServiceProviderConfig' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Serviceproviderconfig /api/v2/scim/v2/users/{userId}: get: tags: - SCIM summary: Get a user description: '' operationId: getScimV2User consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/v2/users. required: true type: string - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "userName", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns the "id", "userName", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: If-None-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified.' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '304': description: If-Non-Match header matches current version. No content returned. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: general.resource.not.found: User could not be found. not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. general.resource.conflict: Conflict with existing user ID. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2User put: tags: - SCIM summary: Replace a user description: '' operationId: putScimV2User consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/v2/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to replace a user. required: true schema: $ref: '#/definitions/ScimV2User' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:edit - directory:user:setPassword - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: putScimV2User delete: tags: - SCIM summary: Delete a user description: '' operationId: deleteScimV2User consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/v2/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/Empty' '204': description: User Deleted with no content returned. '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:delete x-purecloud-method-name: deleteScimV2User patch: tags: - SCIM summary: Modify a user description: '' operationId: patchScimV2User consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: userId in: path description: The ID of a user. Returned with GET /api/v2/scim/v2/users. required: true type: string - name: If-Match in: header description: 'The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: "42". If the ETag is different from the version on the server, returns 400 with a "scimType" of "invalidVers".' required: false type: string - in: body name: body description: The information used to modify a user. required: true schema: $ref: '#/definitions/ScimV2PatchRequest' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '409': description: Version does not match current version. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:edit - directory:user:setPassword - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: patchScimV2User /api/v2/scim/v2/users: get: tags: - SCIM summary: Get a list of users description: To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to "active eq false". By default, returns SCIM attributes "externalId", "enterprise-user:manager", and "roles". To exclude these attributes, set the attributes parameter to "id,active" or the excludeAttributes parameter to "externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division". operationId: getScimV2Users consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - name: startIndex in: query description: The 1-based index of the first query result. required: false type: integer default: 1 format: int32 - name: count in: query description: The requested number of items per page. A value of 0 returns "totalResults". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the "excludedAttributes" or "attributes" query parameters to exclude or only include secondary lookup values such as "externalId", "roles", "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages", or "urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills". required: false type: integer default: 25 format: int32 - name: attributes in: query description: Indicates which attributes to include. Returns these attributes and the "id", "userName", "active", and "meta" attributes. Use "attributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: excludedAttributes in: query description: Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Always returns the "id", "userName", "active", and "meta" attributes. Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. required: false type: array items: type: string enum: - id - userName - displayName - title - active - externalId - phoneNumbers - emails - groups - roles - meta - meta.version - meta.lastModified - urn:ietf:params:scim:schemas:core:2.0:User:id - urn:ietf:params:scim:schemas:core:2.0:User:userName - urn:ietf:params:scim:schemas:core:2.0:User:displayName - urn:ietf:params:scim:schemas:core:2.0:User:title - urn:ietf:params:scim:schemas:core:2.0:User:active - urn:ietf:params:scim:schemas:core:2.0:User:externalId - urn:ietf:params:scim:schemas:core:2.0:User:phoneNumbers - urn:ietf:params:scim:schemas:core:2.0:User:emails - urn:ietf:params:scim:schemas:core:2.0:User:groups - urn:ietf:params:scim:schemas:core:2.0:User:roles - urn:ietf:params:scim:schemas:core:2.0:User:meta - urn:ietf:params:scim:schemas:core:2.0:User:meta.version - urn:ietf:params:scim:schemas:core:2.0:User:meta.lastModified - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:department - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:manager.value - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:employeeNumber - urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:dateHire - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages - urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds collectionFormat: multi - name: filter in: query description: 'Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq search@sample.org", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq search@sample.org", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".' required: false type: string responses: '200': description: successful operation schema: $ref: '#/definitions/ScimUserListResponse' '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '409': description: The request conflicts with the current state of the target resource. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim - scim:readonly x-purecloud-method-name: getScimV2Users post: tags: - SCIM summary: Create a user description: '' operationId: postScimV2Users consumes: - application/scim+json - application/json produces: - application/scim+json - application/json parameters: - in: body name: body description: The information used to create a user. required: true schema: $ref: '#/definitions/ScimV2CreateUser' responses: '200': description: successful operation schema: $ref: '#/definitions/ScimV2User' '201': description: User Created. schema: $ref: '#/definitions/ScimV2User' '409': description: User name already in use by non-deleted user. schema: $ref: '#/definitions/ScimError' x-inin-error-codes: request.conflict: The request conflicts with the current state of the target resource. '400': description: The request could not be understood by the server due to malformed syntax. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: bad.request: The request could not be understood by the server due to malformed syntax. response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ' invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s' client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior. invalid.property: Value [%s] is not a valid property for object [%s] constraint.validation: '%s' invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s' '401': description: No authentication bearer token specified in authorization header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.required: No authentication bearer token specified in authorization header. ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]' bad.credentials: Invalid login credentials. '403': description: You are not authorized to perform the requested action. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s). app.not.authorized.for.scope: App not authorized to use scope %s missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s' not.authorized: You are not authorized to perform the requested action. missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s' authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]' missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s' '404': description: The requested resource was not found. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: not.found: The requested resource was not found. '408': description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads. '413': description: 'The request is over the size limit. Maximum bytes: %s' schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s' '415': description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header. '429': description: Rate limit exceeded the maximum. Retry the request in [%s] seconds schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds '500': description: The server encountered an unexpected condition which prevented it from fulfilling the request. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request. '503': description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance). '504': description: The request timed out. schema: $ref: '#/definitions/ErrorBody' x-inin-error-codes: authentication.request.timeout: Authentication request timeout. request.timeout: The request timed out. security: - PureCloud OAuth: - scim x-inin-requires-permissions: type: ANY permissions: - directory:user:add - authorization:grant:add - authorization:grant:delete - routing:skill:assign - routing:language:assign - telephony:extension:assign x-purecloud-method-name: postScimV2Users definitions: ScimV2Group: type: object required: - displayName properties: id: type: string description: The ID of the SCIM resource. Set by the service provider. "caseExact" is set to "true". "mutability" is set to "readOnly". "returned" is set to "always". readOnly: true schemas: type: array description: The list of supported schemas. readOnly: true items: type: string displayName: type: string description: The display name of the group. readOnly: true externalId: type: string description: The external ID of the group. Set by the provisioning client. "caseExact" is set to "true". "mutability" is set to "readWrite". members: type: array description: The list of members in the group. items: $ref: '#/definitions/ScimV2MemberReference' meta: description: The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC. readOnly: true $ref: '#/definitions/ScimMetadata' description: Defines a SCIM group. ScimV2CreateUser: type: object required: - displayName - userName properties: schemas: type: array description: The list of supported schemas. readOnly: true items: type: string active: type: boolean description: Indicates whether the user's administrative status is active. userName: type: string description: The user's Genesys Cloud email address. Must be unique. displayName: type: string description: The display name of the user. password: type: string description: The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups. title: type: string description: The user's title. phoneNumbers: type: array description: The list of the user's phone numbers. items: $ref: '#/definitions/ScimPhoneNumber' emails: type: array description: The list of the user's email addresses. items: $ref: '#/definitions/ScimEmail' externalId: type: string description: The external ID of the user. Set by the provisioning client. "caseExact" is set to "true". "mutability" is set to "readWrite". groups: type: array description: The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint. readOnly: true items: $ref: '#/definitions/ScimV2GroupReference' roles: type: array description: The list of roles assigned to the user. items: $ref: '#/definitions/ScimUserRole' urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: description: The URI of the schema for the enterprise user. $ref: '#/definitions/ScimV2EnterpriseUser' urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User: description: The URI of the schema for the Genesys Cloud user. $ref: '#/definitions/ScimUserExtensions' description: Defines the creation of a SCIM user. ScimV2SchemaAttribute: type: object properties: name: type: string description: The name of the attribute. readOnly: true type: type: string description: The data type of the attribute. readOnly: true enum: - string - boolean - decimal - integer - dateTime - reference - complex subAttributes: type: array description: The list of subattributes for an attribute of the type "complex". Uses the same schema as "attributes". readOnly: true items: $ref: '#/definitions/ScimV2SchemaAttribute' multiValued: type: boolean description: Indicates whether an attribute contains multiple values. readOnly: true description: type: string description: The description of the attribute. readOnly: true required: type: boolean description: Indicates whether an attribute is required. readOnly: true canonicalValues: type: array description: The list of standard values that service providers may use. Service providers may ignore unsupported values. readOnly: true items: type: string caseExact: type: boolean description: Indicates whether a string attribute is case-sensitive. If set to "true", the server preserves case sensitivity. If set to "false", the server may change the case. The server also uses case sensitivity when evaluating filters. See section 3.4.2.2 "Filtering" in RFC 7644 for details. readOnly: true mutability: type: string description: The circumstances under which an attribute can be defined or redefined. The default is "readWrite". readOnly: true enum: - readWrite - readOnly - immutable - writeOnly returned: type: string description: The circumstances under which an attribute and its values are returned in response to a GET, PUT, POST, or PATCH request. readOnly: true enum: - always - never - default - request uniqueness: type: string description: The method by which the service provider enforces the uniqueness of an attribute value. A server can reject a value by returning the HTTP response code 400 (Bad Request). A client can enforce uniqueness to a greater degree than the server provider enforces. For example, a client could make a value unique even though the server has "uniqueness" set to "none". readOnly: true enum: - none - server - global referenceTypes: type: array description: The list of SCIM resource types that may be referenced. Only applies when "type" is set to "reference". readOnly: true items: type: string enum: - User - Group - external - uri description: A complex type that defines service provider attributes or subattributes and their qualities. Detail: type: object properties: errorCode: type: string fieldName: type: string entityId: type: string entityName: type: string ErrorBody: type: object properties: message: type: string code: type: string status: type: integer format: int32 entityId: type: string entityName: type: string messageWithParams: type: string messageParams: type: object additionalProperties: type: string contextId: type: string details: type: array items: $ref: '#/definitions/Detail' errors: type: array items: $ref: '#/definitions/ErrorBody' limit: $ref: '#/definitions/Limit' ScimUserRole: type: object properties: value: type: string description: The role of the Genesys Cloud user. description: Defines a user role. ScimMetadata: type: object properties: resourceType: type: string description: The type of SCIM resource. readOnly: true enum: - User - Group - ServiceProviderConfig - ResourceType - Schema lastModified: type: string format: date-time description: The last time that the resource was modified. Date time is represented as an "ISO-8601 string", for example, yyyy-MM-ddTHH:mm:ss.SSSZ. Not included with "Schema" and "ResourceType" resources. readOnly: true location: type: string format: uri description: The URI of the resource. readOnly: true version: type: string description: The version of the resource. Matches the ETag HTTP response header. Not included with "Schema" and "ResourceType" resources. readOnly: true description: Defines the SCIM metadata. ScimGroupListResponse: type: object properties: schemas: type: array description: The list of supported schemas. items: type: string totalResults: type: integer format: int64 description: The total number of results. readOnly: true startIndex: type: integer format: int64 description: The 1-based index of the first result returned by this request. Add this to "itemsPerPage" when requesting the next page of results. readOnly: true itemsPerPage: type: integer format: int64 description: The number of resources returned per page. readOnly: true Resources: type: array description: The list of requested resources. If "count" is 0, then the list will be empty. readOnly: true items: $ref: '#/definitions/ScimV2Group' description: Defines a response for a list of SCIM groups. ScimConfigResourceTypesListResponse: type: object properties: schemas: type: array description: The list of supported schemas. items: type: string totalResults: type: integer format: int64 description: The total number of results. readOnly: true startIndex: type: integer format: int64 description: The 1-based index of the first result returned by this request. Add this to "itemsPerPage" when requesting the next page of results. readOnly: true itemsPerPage: type: integer format: int64 description: The number of resources returned per page. readOnly: true Resources: type: array description: The list of requested resources. readOnly: true items: $ref: '#/definitions/ScimConfigResourceType' description: Defines a response for a list of SCIM resource types. ScimUserRoutingSkill: type: object required: - name properties: name: type: string description: The case-sensitive name of a routing skill configured in Genesys Cloud. proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When "Best available skills" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings. description: The routing skill assigned to a user. JsonNode: type: object ScimV2PatchOperation: type: object required: - op properties: op: type: string description: The PATCH operation to perform. enum: - add - replace - remove path: type: string description: The attribute path that describes the target of the operation. Required for a "remove" operation. value: description: The value to set in the path. $ref: '#/definitions/JsonNode' description: Defines a SCIM PATCH operation. The path and value follow very specific rules based on operation types. See section 3.5.2 "Modifying with PATCH" in RFC 7644 for details. ScimPhoneNumber: type: object properties: value: type: string description: The phone number in E.164 or tel URI format, for example, tel:+nnnnnnnn; ext=xxxxx. type: type: string description: The type of phone number. enum: - work - work2 - work3 - work4 - home - mobile - other - microsoftteams - zoomphone - eightbyeight - ringcentral primary: type: boolean description: Indicates whether the phone number is the primary phone number. description: Defines a SCIM phone number. ScimEmail: type: object properties: value: type: string description: The email address. Is immutable if "type" is set to "other". type: type: string description: The type of email address. "value" is immutable if "type" is set to "other". enum: - work - other primary: type: boolean description: Indicates whether the email address is the primary email address. description: Defines a SCIM email address. ScimV2MemberReference: type: object properties: type: type: string description: The type of SCIM resource. readOnly: true enum: - User - Group - ServiceProviderConfig - ResourceType - Schema value: type: string description: The ID of the group member. Can be "userId" or "groupId". $ref: type: string format: uri description: The reference URI of the SCIM resource. readOnly: true description: Defines a reference to SCIM group members. Empty: type: object ScimUserRoutingLanguage: type: object required: - name properties: name: type: string description: The case-sensitive name of a routing language configured in Genesys Cloud. proficiency: type: number format: double description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings. description: The routing language assigned to a user. ScimV2GroupReference: type: object properties: type: type: string description: The type of SCIM resource. readOnly: true enum: - User - Group - ServiceProviderConfig - ResourceType - Schema value: type: string description: The ID of the group member. Can be "userId" or "groupId". $ref: type: string format: uri description: The reference URI of the SCIM resource. readOnly: true description: Defines a reference to SCIM groups. ScimV2PatchRequest: type: object required: - schemas properties: schemas: type: array description: The list of schemas used in the PATCH request. items: type: string Operations: type: array description: The list of operations to perform for the PATCH request. items: $ref: '#/definitions/ScimV2PatchOperation' description: Defines a SCIM PATCH request. See section 3.5.2 "Modifying with PATCH" in RFC 7644 for details. ScimUserListResponse: type: object properties: schemas: type: array description: The list of supported schemas. items: type: string totalResults: type: integer format: int64 description: The total number of results. readOnly: true startIndex: type: integer format: int64 description: The 1-based index of the first result returned by this request. Add this to "itemsPerPage" when requesting the next page of results. readOnly: true itemsPerPage: type: integer format: int64 description: The number of resources returned per page. readOnly: true Resources: type: array description: The list of requested resources. If "count" is 0, then the list will be empty. readOnly: true items: $ref: '#/definitions/ScimV2User' description: Defines a response for a list of SCIM users. Manager: type: object properties: value: type: string description: The ID of the manager. $ref: type: string format: uri description: The reference URI of the manager's user record. readOnly: true description: Defines a SCIM manager. ScimConfigResourceTypeSchemaExtension: type: object properties: schema: type: string description: The URI of an extended schema, for example, "urn:edu:2.0:Staff". Must be equal to the "id" attribute of a schema. readOnly: true required: type: boolean description: Indicates whether a schema extension is required. readOnly: true description: Defines a SCIM resource type's schema extension. Limit: type: object properties: key: type: string namespace: type: string enum: - web.deployments - web.messaging - agent.assistant - agentic.virtual.agents - analytics.agents - analytics.alerting - analytics.data.extraction - analytics - analytics.realtime - analytics.reporting.settings - anomaly.detection - architect - audiohook - audiohook.monitor - audit - auth.api - authorization - automation.testing - bots - bots.voice - business.rules - callback - case.management - cobrowse - content.management - conversation - copilot - dataactions - datatables - directory - dsar - email - employee.engagement - event.orchestration - external.contacts - external.events.data.ingestion - gamification - gcv - gdpr - groups - guides - historical.adherence - infrastructureascode - integrations - intent.miner - internal.messaging - journey - knowledge - language.understanding - learning - limit.registry - marketplace - mcp.analytics.aggregates - mcp - media.communications - messaging - micro.frontend - multi.org - notifications - onboarding - outbound - platform.api - predictive.routing - presence - quality - recording - response.management - routing - scim - screen.monitoring - search - secondary.automation.testing - skills - social.media - speech.and.text.analytics - speech.integration - supportability - task.management - telephony.configuration - usage - users - users.rules - voice.transcription - webchat - webhooks - workforce.management.adherence - workforce.management.agent.availability - workforce.management.forecast - workforce.management - workforce.management.scheduling.preferences - workforce.management.self.schedule - workforce.management.shift.trading - system value: type: integer format: int64 ScimV2EnterpriseUser: type: object properties: division: type: string description: The division that the user belongs to. department: type: string description: The department that the user belongs to. manager: description: The user's manager. $ref: '#/definitions/Manager' employeeNumber: type: string description: The user's employee number. dateHire: type: string description: The user's hire date. Format in JSON will be YYYY-MM-DD. description: Defines a SCIM enterprise user. ScimServiceProviderConfigBulkFeature: type: object properties: supported: type: boolean description: Indicates whether configuration options are supported. readOnly: true maxOperations: type: integer format: int32 description: The maximum number of operations for each bulk request. readOnly: true maxPayloadSize: type: integer format: int32 description: The maximum payload size. readOnly: true description: Defines a "bulk" request in the SCIM service provider's configuration. ScimServiceProviderConfigSimpleFeature: type: object properties: supported: type: boolean description: Indicates whether configuration options are supported. readOnly: true description: Defines a request in the SCIM service provider's configuration. ScimServiceProviderConfigAuthenticationScheme: type: object required: - description - name - type properties: name: type: string description: The name of the authentication scheme, for example, HTTP Basic. readOnly: true description: type: string description: The description of the authentication scheme. readOnly: true specUri: type: string format: uri description: The HTTP-addressable URL that points to the authentication scheme's specification. readOnly: true documentationUri: type: string format: uri description: The HTTP-addressable URL that points to the authentication scheme's usage documentation. readOnly: true type: type: string description: The type of authentication scheme. readOnly: true enum: - oauth - oauth2 - oauthbearertoken - httpbasic - httpdigest primary: type: boolean description: Indicates whether this authentication scheme is the primary method of authentication. readOnly: true description: Defines an authentication scheme in the SCIM service provider's configuration. ScimV2SchemaListResponse: type: object properties: schemas: type: array description: The list of supported schemas. items: type: string totalResults: type: integer format: int64 description: The total number of results. readOnly: true startIndex: type: integer format: int64 description: The 1-based index of the first result returned by this request. Add this to "itemsPerPage" when requesting the next page of results. readOnly: true itemsPerPage: type: integer format: int64 description: The number of resources returned per page. readOnly: true Resources: type: array description: The list of requested resources. readOnly: true items: $ref: '#/definitions/ScimV2SchemaDefinition' description: Defines the list response for SCIM resource types. ScimServiceProviderConfigFilterFeature: type: object properties: supported: type: boolean description: Indicates whether configuration options are supported. readOnly: true maxResults: type: integer format: int32 description: The maximum number of results returned from a filtered query. readOnly: true description: Defines a "filter" request in the SCIM service provider's configuration. ScimV2User: type: object properties: id: type: string description: The ID of the SCIM resource. Set by the service provider. "caseExact" is set to "true". "mutability" is set to "readOnly". "returned" is set to "always". readOnly: true schemas: type: array description: The list of supported schemas. readOnly: true items: type: string active: type: boolean description: Indicates whether the user's administrative status is active. userName: type: string description: The user's Genesys Cloud email address. Must be unique. displayName: type: string description: The display name of the user. password: type: string description: The new password for the Genesys Cloud user. Does not return an existing password. When creating a user, if a password is not supplied, then a password will be randomly generated that is 40 characters in length and contains five characters from each of the password policy groups. title: type: string description: The user's title. phoneNumbers: type: array description: The list of the user's phone numbers. items: $ref: '#/definitions/ScimPhoneNumber' emails: type: array description: The list of the user's email addresses. items: $ref: '#/definitions/ScimEmail' externalId: type: string description: The external ID of the user. Set by the provisioning client. "caseExact" is set to "true". "mutability" is set to "readWrite". groups: type: array description: The list of groups that the user is a member of. This list is immutable per SCIM RFC and may only be updated using the GROUPS resource endpoint. readOnly: true items: $ref: '#/definitions/ScimV2GroupReference' roles: type: array description: The list of roles assigned to the user. items: $ref: '#/definitions/ScimUserRole' urn:ietf:params:scim:schemas:extension:enterprise:2.0:User: description: The URI of the schema for the enterprise user. $ref: '#/definitions/ScimV2EnterpriseUser' urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User: description: The URI of the schema for the Genesys Cloud user. $ref: '#/definitions/ScimUserExtensions' meta: description: The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC. readOnly: true $ref: '#/definitions/ScimMetadata' description: Defines a SCIM user. ScimError: type: object properties: schemas: type: array description: The list of schemas for the SCIM error. readOnly: true items: type: string status: type: string description: The HTTP status code returned for the SCIM error. readOnly: true scimType: type: string description: The type of SCIM error when httpStatus is a "400" error. readOnly: true enum: - invalidFilter - tooMany - uniqueness - mutability - invalidSyntax - invalidPath - noTarget - invalidValue - invalidVers - sensitive detail: type: string description: The detailed description of the SCIM error. readOnly: true description: Defines a SCIM error. ScimConfigResourceType: type: object properties: id: type: string description: The ID of the SCIM resource. Set by the service provider. "caseExact" is set to "true". "mutability" is set to "readOnly". "returned" is set to "always". readOnly: true schemas: type: array description: The list of supported schemas. readOnly: true items: type: string name: type: string description: The name of the resource type. readOnly: true description: type: string description: The description of the resource type. readOnly: true schema: type: string description: The URI of the primary or base schema for the resource type. readOnly: true schemaExtensions: type: array description: The list of schema extensions for the resource type. readOnly: true items: $ref: '#/definitions/ScimConfigResourceTypeSchemaExtension' endpoint: type: string description: The HTTP-addressable endpoint of the resource type. Appears after the base URL. readOnly: true meta: description: The metadata of the SCIM resource. Only "location" and "resourceType" are set for "ResourceType" resources. readOnly: true $ref: '#/definitions/ScimMetadata' description: Defines a SCIM resource. ScimUserExtensions: type: object properties: routingSkills: type: array description: The list of routing skills assigned to a user. Maximum 50 skills. items: $ref: '#/definitions/ScimUserRoutingSkill' routingLanguages: type: array description: The list of routing languages assigned to a user. Maximum 50 languages. items: $ref: '#/definitions/ScimUserRoutingLanguage' externalIds: type: array description: The list of external identifiers assigned to user. Always includes an immutable SCIM authority prefixed with "x-pc:scimv2:v1". ExternalIds are searchable with complex filter query parameter using 'authority' and 'value', e.g., filter=urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:externalIds[authority eq "matchAuthName" and value eq "matchingExternalKeyValue"]. items: $ref: '#/definitions/ScimGenesysUserExternalId' description: Genesys Cloud user extensions to SCIM RFC. ScimV2SchemaDefinition: type: object properties: id: type: string description: The ID of the SCIM resource. Set by the service provider. "caseExact" is set to "true". "mutability" is set to "readOnly". "returned" is set to "always". readOnly: true name: type: string description: The name of the schema. readOnly: true description: type: string description: The description of the schema. readOnly: true attributes: type: array description: The list of service provider attributes. readOnly: true items: $ref: '#/definitions/ScimV2SchemaAttribute' meta: description: The metadata of the SCIM resource. Only "location" and "resourceType" are set for "Schema" resources. readOnly: true $ref: '#/definitions/ScimMetadata' description: Defines a SCIM schema. ScimServiceProviderConfig: type: object properties: schemas: type: array description: The list of supported schemas. readOnly: true items: type: string documentationUri: type: string format: uri description: The HTTP-addressable URL that points to the service provider's documentation. readOnly: true patch: description: The "patch" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigSimpleFeature' filter: description: The "filter" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigFilterFeature' etag: description: The "etag" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigSimpleFeature' sort: description: The "sort" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigSimpleFeature' bulk: description: The "bulk" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigBulkFeature' changePassword: description: The "changePassword" configuration options. readOnly: true $ref: '#/definitions/ScimServiceProviderConfigSimpleFeature' authenticationSchemes: type: array description: The list of supported authentication schemes. readOnly: true items: $ref: '#/definitions/ScimServiceProviderConfigAuthenticationScheme' meta: description: The metadata of the SCIM resource. Metadata is defined as immutable per SCIM RFC. readOnly: true $ref: '#/definitions/ScimMetadata' description: Defines a SCIM service provider's configuration. ScimGenesysUserExternalId: type: object required: - authority - value properties: authority: type: string description: Authority, or scope, of "externalId". Allows multiple external identifiers to be defined. Represents the source of the external identifier. value: type: string description: Identifier of the user in an external system. description: External Identifiers of user. The external identifier must be unique within the organization and the 'authority' securityDefinitions: PureCloud OAuth: type: oauth2 authorizationUrl: https://login.mypurecloud.com/authorize flow: implicit scopes: all: All the scopes Guest Chat JWT: type: apiKey name: Authorization in: header externalDocs: description: PureCloud API Documentation url: https://developer.genesys.cloud/