How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Genesys SCIM API

System for Cross-domain Identity Management

Genesys SCIM API is one of 87 APIs that Genesys publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include SCIM. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 30 operations across 18 paths, and defines 36 schemas. It is described by OpenAPI 2.0, at version v2.

Requests are made against the base URL https://api.mypurecloud.com.

30 operations 18 paths 36 schemas 2 DELETE18 GET4 PATCH2 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
v2
Base URL
https://api.mypurecloud.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Genesys SCIM API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (PureCloud OAuth) using the implicit flow, exposing 1 scope. An API key is passed in the header as Authorization (Guest Chat JWT).

Paths & Operations 30

Across 18 paths, the API surfaces 30 operations — 2 DELETE, 18 GET, 4 PATCH, 2 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

SCIM 30

System for Cross-domain Identity Management

GET
/api/v2/scim/resourcetypes/{resourceType}
Get a resource type
getScimResourcetype 1 param → 200400401403404408409413
GET
/api/v2/scim/resourcetypes
Get a list of resource types
getScimResourcetypes → 200400401403404408409413
GET
/api/v2/scim/schemas/{schemaId}
Get a SCIM schema
getScimSchema 1 param → 200400401403404408409413
GET
/api/v2/scim/schemas
Get a list of SCIM schemas
getScimSchemas 1 param → 200400401403404408409413
GET
/api/v2/scim/groups
Get a list of groups
getScimGroups 5 params → 200400401403404408409413
GET
/api/v2/scim/groups/{groupId}
Get a group
getScimGroup 4 params → 200304400401403404408409
PUT
/api/v2/scim/groups/{groupId}
Replace a group
putScimGroup 3 params → 200409400401403404408413
PATCH
/api/v2/scim/groups/{groupId}
Modify a group
patchScimGroup 3 params → 200409400401403404408413
GET
/api/v2/scim/serviceproviderconfig
Get a service provider's configuration
getScimServiceproviderconfig 1 param → 200400401403404408409413
GET
/api/v2/scim/users/{userId}
Get a user
getScimUser 4 params → 200304400401403404408409
PUT
/api/v2/scim/users/{userId}
Replace a user
putScimUser 3 params → 200409400401403404408413
DELETE
/api/v2/scim/users/{userId}
Delete a user
deleteScimUser 2 params → 200204409400401403404408
PATCH
/api/v2/scim/users/{userId}
Modify a user
patchScimUser 3 params → 200409400401403404408413
GET
/api/v2/scim/users
Get a list of users
getScimUsers 5 params → 200400401403404408409413
POST
/api/v2/scim/users
Create a user
postScimUsers 1 param → 200201409400401403404408
GET
/api/v2/scim/v2/resourcetypes/{resourceType}
Get a resource type
getScimV2Resourcetype 1 param → 200400401403404408409413
GET
/api/v2/scim/v2/resourcetypes
Get a list of resource types
getScimV2Resourcetypes → 200400401403404408409413
GET
/api/v2/scim/v2/schemas/{schemaId}
Get a SCIM schema
getScimV2Schema 1 param → 200400401403404408409413
GET
/api/v2/scim/v2/schemas
Get a list of SCIM schemas
getScimV2Schemas 1 param → 200400401403404408409413
GET
/api/v2/scim/v2/groups
Get a list of groups
getScimV2Groups 5 params → 200400401403404408409413
GET
/api/v2/scim/v2/groups/{groupId}
Get a group
getScimV2Group 4 params → 200304400401403404408409
PUT
/api/v2/scim/v2/groups/{groupId}
Replace a group
putScimV2Group 3 params → 200409400401403404408413
PATCH
/api/v2/scim/v2/groups/{groupId}
Modify a group
patchScimV2Group 3 params → 200409400401403404408413
GET
/api/v2/scim/v2/serviceproviderconfig
Get a service provider's configuration
getScimV2Serviceproviderconfig 1 param → 200400401403404408409413
GET
/api/v2/scim/v2/users/{userId}
Get a user
getScimV2User 4 params → 200304400401403404408409
PUT
/api/v2/scim/v2/users/{userId}
Replace a user
putScimV2User 3 params → 200409400401403404408413
DELETE
/api/v2/scim/v2/users/{userId}
Delete a user
deleteScimV2User 2 params → 200204409400401403404408
PATCH
/api/v2/scim/v2/users/{userId}
Modify a user
patchScimV2User 3 params → 200409400401403404408413
GET
/api/v2/scim/v2/users
Get a list of users
getScimV2Users 5 params → 200400401403404408409413
POST
/api/v2/scim/v2/users
Create a user
postScimV2Users 1 param → 200201409400401403404408

Schemas 36

The contract defines 36 schemas that model the data the API accepts and returns. The most detailed are ScimV2User (15 properties), ScimV2CreateUser (13 properties), ScimV2SchemaAttribute (12 properties), ErrorBody (11 properties). Each schema is shown below with its type and property counts.

ScimV2Group
object
Defines a SCIM group.
6 properties 1 required
ScimV2CreateUser
object
Defines the creation of a SCIM user.
13 properties 2 required
ScimV2SchemaAttribute
object
A complex type that defines service provider attributes or subattributes and their qualities.
12 properties
Detail
object
4 properties
ErrorBody
object
11 properties
ScimUserRole
object
Defines a user role.
1 property
ScimMetadata
object
Defines the SCIM metadata.
4 properties
ScimGroupListResponse
object
Defines a response for a list of SCIM groups.
5 properties
ScimConfigResourceTypesListResponse
object
Defines a response for a list of SCIM resource types.
5 properties
ScimUserRoutingSkill
object
The routing skill assigned to a user.
2 properties 1 required
JsonNode
object
ScimV2PatchOperation
object
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 fo…
3 properties 1 required
ScimPhoneNumber
object
Defines a SCIM phone number.
3 properties
ScimEmail
object
Defines a SCIM email address.
3 properties
ScimV2MemberReference
object
Defines a reference to SCIM group members.
3 properties
Empty
object
ScimUserRoutingLanguage
object
The routing language assigned to a user.
2 properties 1 required
ScimV2GroupReference
object
Defines a reference to SCIM groups.
3 properties
ScimV2PatchRequest
object
Defines a SCIM PATCH request. See section 3.5.2 "Modifying with PATCH" in RFC 7644 for details.
2 properties 1 required
ScimUserListResponse
object
Defines a response for a list of SCIM users.
5 properties
Manager
object
Defines a SCIM manager.
2 properties
ScimConfigResourceTypeSchemaExtension
object
Defines a SCIM resource type's schema extension.
2 properties
Limit
object
3 properties
ScimV2EnterpriseUser
object
Defines a SCIM enterprise user.
5 properties
ScimServiceProviderConfigBulkFeature
object
Defines a "bulk" request in the SCIM service provider's configuration.
3 properties
ScimServiceProviderConfigSimpleFeature
object
Defines a request in the SCIM service provider's configuration.
1 property
ScimServiceProviderConfigAuthenticationScheme
object
Defines an authentication scheme in the SCIM service provider's configuration.
6 properties 3 required
ScimV2SchemaListResponse
object
Defines the list response for SCIM resource types.
5 properties
ScimServiceProviderConfigFilterFeature
object
Defines a "filter" request in the SCIM service provider's configuration.
2 properties
ScimV2User
object
Defines a SCIM user.
15 properties
ScimError
object
Defines a SCIM error.
4 properties
ScimConfigResourceType
object
Defines a SCIM resource.
8 properties
ScimUserExtensions
object
Genesys Cloud user extensions to SCIM RFC.
3 properties
ScimV2SchemaDefinition
object
Defines a SCIM schema.
5 properties
ScimServiceProviderConfig
object
Defines a SCIM service provider's configuration.
10 properties
ScimGenesysUserExternalId
object
External Identifiers of user. The external identifier must be unique within the organization and the 'authority'
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

genesys-scim-api-openapi.yml Raw ↑

Other APIs Genesys publishes across the network.

Genesys Agent Assistants API
Genesys Agent Copilot API
Genesys Agent UI API
Genesys AI Studio API
Genesys Alerting API
Genesys Analytics API
Genesys Architect API
Genesys Assistant Copilot Variations API
Genesys Audit API
Genesys Authorization API
Genesys Background Assistant API
Genesys Billing API
Where this information came from

This is an independent, third-party profile of Genesys SCIM API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.