Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/nice:nice-scim-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Nice SCIM API
version: v1
description: 'Operations tagged SCIM across 2 of this provider''s published API definitions: nice-cxone-scim.json, nice-cxone-scim-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: SCIM
description: ': System for Cross domain Identity Management'
paths:
/scim/v2/Users:
get:
x-cxone-api-key: 45caaf9b-1da9-4116-81ea-176836ec36b9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API to search user based on user name
description: This API will be used by SCIM Clients(like OKTA) to check if user with given user name exists in User Hub
operationId: searchUser
tags:
- SCIM
parameters:
- name: filter
in: query
required: true
schema:
type: string
description: Supported - eq and Supported Filter Fields - userName. For example, userName eq "user@gmail.com"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimUserSearchResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'500':
description: Internal Error
'502':
description: Bad Gateway
post:
x-cxone-api-key: 45caaf9b-1da9-4116-81ea-176836ec36b9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API Create SCIM User
description: This API will be used to create a SCIM User in User Hub
operationId: registerScimUser
tags:
- SCIM
requestBody:
required: true
description: Data User for create Scim User
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestCreate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'409':
description: Conflict - User already exists
content:
application/json:
schema:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
detail:
type: string
description: Error message
status:
type: integer
description: HTTP status code
'500':
description: Internal Error
'502':
description: Bad Gateway
/scim/v2/Users/{userId}:
get:
tags:
- SCIM
summary: API to get SCIM User By ID
description: This API will be used to get SCIM User by ID
operationId: getScimUserById
parameters:
- name: userId
in: path
description: Id of User to get User details
required: true
schema: {}
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
put:
x-cxone-api-key: 45caaf9b-1da9-4116-81ea-176836ec36b9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API Update SCIM User
description: This API will be used to update a SCIM User in User Hub
operationId: updateScimUser
tags:
- SCIM
parameters:
- name: userId
in: path
description: Id of User to be updated
required: true
schema: {}
requestBody:
required: true
description: Scim User Info for Update
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestUpdate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
patch:
summary: API for Partial Updates SCIM User
description: This API will be used to update a SCIM User in User Hub
operationId: updateScimUserPatch
tags:
- SCIM
parameters:
- name: userId
in: path
description: Id of User to be updated
required: true
schema: {}
requestBody:
required: true
description: Scim User fields for Patch Update
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestPatchUpdate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
/scim/v2/Schemas:
get:
x-cxone-api-key: 45caaf9b-1da9-4116-81ea-176836ec36b9
x-cxone-audience: external-public
tags:
- SCIM
summary: Schema for User Entity
description: This API is used to get Schema for user Entity
operationId: getSchemas
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - invalid request data
'500':
description: Internal Error
'502':
description: Bad Gateway
/basic-auth/scim/v2/Users:
get:
x-cxone-api-key: ba0919c5-86f5-49e9-84d7-c92d1657c1d9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API to search user based on user name with basic auth
description: This API will be used by SCIM Clients(like OKTA) to check if user with given user name exists in User Hub, with support for basic authentication credentials
operationId: get-basic-auth-Users
tags:
- SCIM
parameters:
- name: filter
in: query
required: true
schema:
type: string
description: Supported - eq and Supported Filter Fields - userName. For example, userName eq "user@gmail.com"
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimUserSearchResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'500':
description: Internal Error
'502':
description: Bad Gateway
post:
x-cxone-api-key: ba0919c5-86f5-49e9-84d7-c92d1657c1d9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API Create SCIM User with basic auth
description: This API will be used to create a SCIM User in User Hub with support for basic authentication credentials
operationId: post-basic-auth-users
tags:
- SCIM
requestBody:
required: true
description: Data User for create Scim User
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestCreate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'409':
description: Conflict - User already exists
content:
application/json:
schema:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
detail:
type: string
description: Error message
status:
type: integer
description: HTTP status code
'500':
description: Internal Error
'502':
description: Bad Gateway
/basic-auth/scim/v2/Users/{userId}:
get:
tags:
- SCIM
summary: API to get SCIM User By ID with basic auth
description: This API will be used to get SCIM User by ID with support for basic authentication credentials
operationId: get-basicauth-ScimUserbyID
parameters:
- name: userId
in: path
description: Id of User to get User details
required: true
schema: {}
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
put:
summary: API Update SCIM User with basic auth
description: This API will be used to update a SCIM User in User Hub with support for basic authentication credentials
operationId: put-basicauth-ScimUserbyID
tags:
- SCIM
parameters:
- name: userId
in: path
description: Id of User to be updated
required: true
schema: {}
requestBody:
required: true
description: Scim User Info for Update
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestUpdate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
patch:
x-cxone-api-key: ba0919c5-86f5-49e9-84d7-c92d1657c1d9
x-cxone-audience: external-public
x-cxone-productCatalogPermissions:
- scim: scim
summary: API for Partial Updates SCIM User with basic auth
description: This API will be used to update a SCIM User in User Hub with support for basic authentication credentials
operationId: patch-basic-auth-ScimUserbyID
tags:
- SCIM
parameters:
- name: userId
in: path
description: Id of User to be updated
required: true
schema: {}
requestBody:
required: true
description: Scim User fields for Patch Update
content:
application/json:
schema:
$ref: '#/components/schemas/ScimRequestPatchUpdate'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/ScimResponse'
'400':
description: Bad Request
'401':
description: Unauthorized- SCIM Permission not granted
'403':
description: Forbidden - invalid request data
'404':
description: User Not Found
'500':
description: Internal Error
'502':
description: Bad Gateway
/basic-auth/scim/v2/Schemas:
get:
x-cxone-api-key: ba0919c5-86f5-49e9-84d7-c92d1657c1d9
x-cxone-audience: external-public
tags:
- SCIM
summary: Schema for User Entity with basic auth
description: This API is used to get Schema for user Entity with support for basic authentication credentials
operationId: get-basic-auth-Schemas
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SchemaResponse'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden - invalid request data
'500':
description: Internal Error
'502':
description: Bad Gateway
components:
schemas:
EmailAttribute:
type: object
properties:
type:
type: string
description: Email type
value:
type: string
description: Email ID of the user
primary:
type: boolean
description: Whether is primary email or not
required:
- value
UserExtension:
type: object
properties:
team:
$ref: '#/components/schemas/ScimTeam'
loginAuthenticator:
$ref: '#/components/schemas/ScimLoginAuthenticator'
required:
- givenName
- familyName
ScimLoginAuthenticator:
type: object
properties:
display:
type: string
description: Name of login authenticator
default: null
value:
type: string
description: Id of login authenticator
default: null
UserSearchItemsResponse:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
id:
type: string
description: Id from the User in UUID format
userName:
type: string
description: User Name of the User
name:
allOf:
- $ref: '#/components/schemas/NameAttribute'
description: First Name and Last Name
emails:
type: array
items:
$ref: '#/components/schemas/EmailAttribute'
displayName:
type: string
description: Display Name of the User
locale:
type: string
description: Locale of the User
externalId:
type: string
description: External Id of the User
active:
type: boolean
description: Where the user is active or not
timeZone:
type: string
description: Time Zone of the User
meta:
type: object
properties:
resourceType:
type: string
description: The name of the resource type of the resource.
urn:ietf:params:scim:schemas:extension:nice:2.0:User:
allOf:
- $ref: '#/components/schemas/UserExtension'
description: 'User extension: Login Authenticator and Team'
roles:
type: array
description: List of roles
items:
$ref: '#/components/schemas/ScimRole'
userType:
type: string
description: Type of the User
SchemaResponse:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
totalResults:
type: integer
description: The total number of results returned by the list or query operation.
startIndex:
type: integer
description: The 1-based index of the first result in the current set of list results.
itemsPerPage:
type: integer
description: The number of resources returned in a list response page.
Resources:
type: array
items:
$ref: '#/components/schemas/SchemaAttribute'
Attribute:
type: object
properties:
name:
type: string
description: The attribute's name
type:
type: string
description: The attribute's data type
multiValued:
type: boolean
description: A boolean indicating an attribute's plurality
description:
type: string
description: The attribute's human-readable description.
required:
type: boolean
description: A boolean indicating whether or not the attribute is required
caseExact:
type: boolean
description: A boolean indicating whether or not a string attribute is case sensitive
mutability:
type: string
description: A string indicating the circumstances under which the value of the attribute can be modified
returned:
type: string
description: A string indicating when an attribute is returned in a response
uniqueness:
type: string
description: A string indicating how the service provider enforces uniqueness of attribute values
ScimRole:
type: object
properties:
display:
type: string
description: Name of role
value:
type: string
description: Id of role
primary:
type: boolean
description: Whether role is primary or not
ScimRequestCreate:
type: object
properties:
userName:
type: string
description: User Name of the User
name:
allOf:
- $ref: '#/components/schemas/NameAttribute'
description: First Name and Last Name
emails:
type: array
items:
$ref: '#/components/schemas/EmailAttribute'
urn:ietf:params:scim:schemas:extension:nice:2.0:User:
allOf:
- $ref: '#/components/schemas/UserExtension'
description: 'User extension: Login Authenticator and Team. Only Id or name is needed order to create'
roles:
type: array
description: List of roles
items:
$ref: '#/components/schemas/ScimRoleRequest'
displayName:
type: string
description: Display Name of the User
active:
type: boolean
description: Active status of the User
userType:
type: string
description: Type of the User
timezone:
type: string
description: Time Zone of the User
phoneNumbers:
type: array
items:
type: object
properties:
type:
type: string
description: Phone Number type
value:
type: string
description: Phone Number of the user
primary:
type: boolean
description: Whether phone number is primary or not
required:
- value
required:
- userName
- name
- emails
NameAttribute:
type: object
properties:
givenName:
type: string
description: First Name of the User
familyName:
type: string
description: Last Name of the User
middleName:
type: string
description: Middle Name of the User
required:
- givenName
- familyName
ScimRoleRequest:
type: object
description: Only name or Id is needed
properties:
display:
type: string
description: Name of role
value:
type: string
description: Id of role
ScimUserSearchResponse:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
totalResults:
type: integer
description: The total number of results returned by the list or query operation.
Resources:
type: array
items:
$ref: '#/components/schemas/UserSearchItemsResponse'
ScimRequestUpdate:
type: object
properties:
id:
type: string
description: Id from User in UUID format
userName:
type: string
description: User Name of the User
name:
allOf:
- $ref: '#/components/schemas/NameAttribute'
description: First Name and Last Name
emails:
type: array
items:
$ref: '#/components/schemas/EmailAttribute'
displayName:
type: string
description: Display Name of the User
active:
type: boolean
description: Active status of the User
userType:
type: string
description: Type of the User
urn:ietf:params:scim:schemas:extension:nice:2.0:User:
allOf:
- $ref: '#/components/schemas/UserExtension'
description: 'User extension: Login Authenticator and Team. Only Id or name is needed order to update'
roles:
type: array
description: List of roles
items:
$ref: '#/components/schemas/ScimRoleRequest'
phoneNumbers:
type: array
items:
type: object
properties:
type:
type: string
description: Phone Number type
value:
type: string
description: Phone Number of the user
primary:
type: boolean
description: Whether phone number is primary or not
required:
- value
timezone:
type: string
description: Time Zone of the User
required:
- id
- userName
- name
- emails
- active
ScimTeam:
type: object
properties:
display:
type: string
description: 'Name of team '
value:
type: string
description: Id of tean
ScimRequestPatchUpdate:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas. PatchOp uri is required
Operations:
type: array
items:
type: object
properties:
path:
type: string
description: The attribute name to be modified
value:
type: string
description: The value to be assigned to the attribute
required:
- path
- value
description: The URIs of the individual schemas. PatchOp uri is required
required:
- schemas
- Operations
ScimResponse:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas
id:
type: string
description: Id from the User in UUID format
userName:
type: string
description: User Name of the User
name:
allOf:
- $ref: '#/components/schemas/NameAttribute'
description: First Name and Last Name
emails:
type: array
items:
$ref: '#/components/schemas/EmailAttribute'
displayName:
type: string
description: Display Name of the User
locale:
type: string
description: Locale of the User
externalId:
type: string
description: External Id of the User
active:
type: boolean
description: Where the user is active or not
meta:
type: object
properties:
resourceType:
type: string
description: The name of the resource type of the resource.
userType:
type: string
description: Type of the User
urn:ietf:params:scim:schemas:extension:nice:2.0:User:
allOf:
- $ref: '#/components/schemas/UserExtension'
description: 'User extension: Login Authenticator and Team'
roles:
type: array
description: List of roles
items:
$ref: '#/components/schemas/ScimRole'
phoneNumbers:
type: array
items:
type: object
properties:
type:
type: string
description: Phone Number type
value:
type: string
description: Phone Number of the user
primary:
type: boolean
description: Whether phone number is primary or not
timeZone:
type: string
description: Time Zone of the User
SchemaAttribute:
type: object
properties:
schemas:
type: array
items:
type: string
description: The URIs of the individual schemas.
meta:
type: object
properties:
resourceType:
type: string
description: The name of the resource type of the resource.
location:
type: string
description: The resource's location URI.
id:
type: string
description: The unique URI of the schema.
name:
type: string
description: The schema's human-readable name.
description:
type: string
description: The schema's human-readable description.
attributes:
type: array
items:
$ref: '#/components/schemas/Attribute'
x-refined-from:
- nice-cxone-scim.json
- nice-cxone-scim-openapi.yml