Cvent User SCIM API
The [SCIM](https://www.simplecloud.info/) standard allows for easier cross-domain identity management. This API allows you to manage your account users and SCIM groups (representing Cvent user roles).
The [SCIM](https://www.simplecloud.info/) standard allows for easier cross-domain identity management. This API allows you to manage your account users and SCIM groups (representing Cvent user roles).
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/cvent-user-scim-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.0.2
info:
title: Cvent REST APIs — User SCIM
version: ea
description: The [SCIM](https://www.simplecloud.info/) standard allows for easier cross-domain identity management. This
API allows you to manage your account users and SCIM groups (representing Cvent user roles).
contact:
name: Cvent Development Platform
url: https://developers.cvent.com/
externalDocs:
description: Cvent REST API documentation
url: https://developers.cvent.com/documentation
servers:
- url: https://api-platform.cvent.com/ea
- url: https://api-platform-eur.cvent.com/ea
tags:
- name: User SCIM
description: The [SCIM](https://www.simplecloud.info/) standard allows for easier cross-domain identity management. This
API allows you to manage your account users and SCIM groups (representing Cvent user roles).
paths:
/scim/v2/Groups:
get:
summary: Get SCIM Groups
operationId: getUserGroups
description: Gets a paginated list of SCIM groups (representing Cvent user roles) in an account.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
responses:
'200':
$ref: '#/components/responses/UsersGroupsResponse'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'429':
$ref: '#/components/responses/TooManyRequests20'
parameters:
- $ref: '#/components/parameters/startIndex'
- $ref: '#/components/parameters/count1'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/ResourceTypes:
get:
summary: List Resource Types
operationId: getResourceTypes
description: Gets a list of resource types.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
responses:
'200':
$ref: '#/components/responses/ResourceTypes'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/ResourceTypes/{id}:
get:
summary: Get Resource Type
operationId: getResourceType
description: Gets the details of a single resource type.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
parameters:
- $ref: '#/components/parameters/resourceId'
responses:
'200':
description: Successfully retrieved a Resource.
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceType'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'404':
$ref: '#/components/responses/NotFound21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/Schemas:
get:
summary: List Schemas
operationId: getSchemas
description: Gets the paginated list of user schemas and its extension models representing the user and SCIM groups
(representing Cvent user roles).
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
responses:
'200':
$ref: '#/components/responses/UsersSchemaResponse'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/Schemas/{id}:
get:
summary: Get Schema
operationId: getSchema
description: Gets the details of a user schema and its extension models representing the user and SCIM groups (representing
Cvent user roles).
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
parameters:
- $ref: '#/components/parameters/schemaId'
responses:
'200':
description: Successfully retrieved a schema.
content:
application/json:
schema:
$ref: '#/components/schemas/UsersSchema'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'404':
$ref: '#/components/responses/NotFound21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/ServiceProviderConfig:
get:
summary: Get Service Provider Config
operationId: getServiceProviderConfig
description: Gets Cvent's configurations of SCIM.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
responses:
'200':
$ref: '#/components/responses/ServiceProviderConfig'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/Users:
post:
summary: Create User
operationId: createUser
description: Creates a new user. For account users, the email address will initially be unverified. To verify it, please
click on the link provided in the email sent to your email address.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:write
- OAuth2.authorizationCode:
- account/users:write
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'201':
description: Successfully created a user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'409':
$ref: '#/components/responses/Conflict15'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
get:
summary: List Users
operationId: listUsers
description: Gets a list of users.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
parameters:
- $ref: '#/components/parameters/startIndex'
- $ref: '#/components/parameters/count1'
- name: filter
in: query
required: false
description: 'Use filter query parameters to limit results
to data that matches your criteria. See
[Filters](/docs/rest-api/reference/filters) for details.
Supported fields and operators are listed below:
| Field | Operators |
|-------------------|------------------------------------|
| userName | `eq`, `ne` |
| groups.value | `eq`, `ne` |
| active | `eq`, `ne` |
| id | `eq`, `ne` |
| emails.value | `eq`, `ne` |
| meta.lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
| meta.created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |
The following logical operators are supported for combining filters:
* and
* or
'
schema:
type: string
example: userName eq 'john@example.com' or userName eq 'Matt@example.com'
responses:
'200':
description: Successfully retrieved a paginated list of Users.
content:
application/json:
schema:
$ref: '#/components/schemas/Users'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
/scim/v2/Users/{id}:
get:
summary: Get User
operationId: getUser
description: Gets the details of a single user.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:read
- OAuth2.authorizationCode:
- account/users:read
parameters:
- $ref: '#/components/parameters/userId1'
responses:
'200':
description: Successfully retrieved a user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'404':
$ref: '#/components/responses/NotFound21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
put:
summary: Update User
operationId: updateUser
description: Updates a user. In case of an account user, if the email address field is updated then please verify the
new email address using the link received in the verification email.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:write
- OAuth2.authorizationCode:
- account/users:write
parameters:
- $ref: '#/components/parameters/userId1'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/User'
responses:
'200':
description: Successfully updated a user.
content:
application/json:
schema:
$ref: '#/components/schemas/User'
'400':
$ref: '#/components/responses/BadRequest21'
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'404':
$ref: '#/components/responses/NotFound21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
delete:
summary: Delete User
operationId: deleteUser
description: Deletes a user.
tags:
- User SCIM
security:
- OAuth2.clientCredentials:
- account/users:delete
- OAuth2.authorizationCode:
- account/users:delete
parameters:
- $ref: '#/components/parameters/userId1'
responses:
'204':
description: Successfully deleted a User.
headers: {}
'401':
$ref: '#/components/responses/Unauthorized21'
'403':
$ref: '#/components/responses/Forbidden21'
'404':
$ref: '#/components/responses/NotFound21'
'429':
$ref: '#/components/responses/TooManyRequests20'
externalDocs:
description: More about OAuth2 authorization code support for administrators
url: '#oauth2-auth-code-planner-admin'
components:
schemas:
Name:
title: Name
description: The name of the user.
type: object
required:
- givenName
- familyName
properties:
givenName:
type: string
description: The given/first name of the user.
example: Mike
minLength: 1
maxLength: 30
familyName:
type: string
description: The family/last name of the user.
example: Stuart
minLength: 1
maxLength: 50
middleName:
type: string
description: The middle name of the user.
example: A
maxLength: 30
honorificPrefix:
type: string
description: The prefix of the user.
example: Mr.
maxLength: 30
UserType:
title: UserType
description: The type of the user.
enum:
- Planner Account User
type: string
example: Planner Account User
EmailType1:
title: Email Type
description: The type of the email.
enum:
- work
- home
type: string
example: work
default: work
Attribute:
title: Attribute
description: Attribute
type: object
properties:
name:
type: string
description: The name of the attribute.
example: userName
type:
$ref: '#/components/schemas/AttributeDataType'
multiValued:
type: boolean
description: Indicates if the attribute is multivalued.
example: true
description:
type: string
description: The description of the attribute.
example: This Attribute describes the property
required:
type: boolean
description: True indicates the attribute is required.
example: true
caseExact:
type: boolean
description: True indicates the attribute is case sensitive.
example: false
mutability:
$ref: '#/components/schemas/Mutability'
canonicalValues:
type: array
description: The list of canonical values of the attribute.
items:
type: string
example: work
returned:
$ref: '#/components/schemas/ReturnedType'
uniqueness:
$ref: '#/components/schemas/UniquenessType'
referenceTypes:
type: array
description: This is used to denote the reference type of the attribute.
items:
$ref: '#/components/schemas/ReferenceType'
subAttributes:
type: array
description: A collection of sub-attributes. Has the same structure as this attribute object.
items:
$ref: '#/components/schemas/Attribute'
Group:
title: Group
description: Generic sample name. Not a real model used by any Cvent service.
type: object
required:
- value
properties:
value:
type: string
description: The unique ID of the SCIM group.
format: uuid
readOnly: false
example: 3b2359a7-4583-40ed-8afd-67e5f15373d3
display:
type: string
description: The name of the user role.
example: Admin
Meta:
title: Meta
description: Metadata of the resource.
type: object
readOnly: true
properties:
resourceType:
type: string
readOnly: true
description: The type of the resource.
example: user
location:
type: string
readOnly: true
format: uri
description: The location (URI) of the resource.
example: https://<account>/scim/v2/Users/2
created:
type: string
format: date-time
readOnly: true
description: The ISO 8601 zoned date time when this record was created.
example: '2021-12-16T00:59:14.570Z'
lastModified:
type: string
format: date-time
readOnly: true
description: The ISO 8601 zoned date time when this record was modified.
example: '2021-12-16T00:59:14.570Z'
AddressType1:
title: AddressType
description: The type of the address.
enum:
- work
- home
type: string
example: work
ErrorScimType:
title: ErrorScimType
description: This is used to denote the scim type of the error.
enum:
- invalidFilter
- uniqueness
- invalidSyntax
- invalidValue
type: string
example: invalidSyntax
Address6:
title: Address
description: Address
type: object
required:
- type
- primary
properties:
type:
$ref: '#/components/schemas/AddressType1'
streetAddress:
type: string
description: The street address of the user.
example: 100 Universal City Plaza
maxLength: 40
locality:
type: string
description: The locality/city of the user.
example: Hollywood
maxLength: 40
region:
type: string
description: The region/state/province of the user.
example: CA
postalCode:
type: string
description: Postal code (also known as zipcode) of the user.
example: '91608'
country:
type: string
description: The country of the user.
example: USA
primary:
type: boolean
description: True indicates the address is primary.
example: true
default: false
UserEnterpriseExtension:
title: User Enterprise Extension
description: Enterprise extension model for the user.
type: object
required:
- sendLoginDetails
properties:
sendLoginDetails:
type: boolean
description: Indicates if the login details are to be sent to user.
example: true
default: true
federatedId:
type: string
description: The ID of the user in your identity management system. Used when you leverage identity management software
and need to identify a user by a value other than their Cvent username.
example: AKJU783UP
minLength: 1
maxLength: 100
company:
type: string
description: The company of the user.
example: Cvent
maxLength: 100
workFax:
type: string
description: The work fax number of the user
example: '+1123456'
maxLength: 30
homeFax:
type: string
description: The home fax number of the user.
example: '+1123456'
maxLength: 30
pager:
type: string
description: The pager number of the user.
example: '+1123456'
maxLength: 30
UserGroups1:
title: Groups
description: Groups
type: object
properties:
schemas:
type: array
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
description: The collection of user schemas.
itemsPerPage:
type: integer
description: The number of schemas per page.
example: 50
startIndex:
type: integer
description: Starting index of the response.
example: 1
totalResults:
type: integer
description: The total count of schemas.
example: 5
Resources:
type: array
items:
$ref: '#/components/schemas/Group-1'
description: The collection of schema resources.
ServiceProviderConfig:
title: ServiceProviderConfigs
description: Service Provider Configs
type: object
properties:
schemas:
type: array
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
description: The list of schemas using this resource.
documentationUri:
type: string
format: uri
description: The location of the API documentation.
example: https://developers.cvent.com/documentation#section/Introduction
patch:
description: Config details for patch operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the patch operation is supported.
example: false
bulk:
description: Config details for bulk operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the bulk operation is supported.
example: false
maxOperations:
type: integer
description: An integer value specifying the maximum number of operations.
example: 1
maxPayloadSize:
type: integer
description: An integer value specifying the maximum payload size in bytes.
example: 1048576
filter:
description: Config details for filter operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the filteration is supported.
example: false
maxResults:
type: integer
description: The maximum number of results in the response.
example: 100
changePassword:
description: Config details for change password operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the password change is supported.
example: false
sort:
description: Config details for sort operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the sort operation is supported.
example: false
etag:
description: Config details for change e-tag operations.
type: object
properties:
supported:
type: boolean
description: Indicates if the entity tag operation is supported.
example: false
authenticationSchemes:
type: array
items:
$ref: '#/components/schemas/AuthenticationSchema'
description: The collection of authentication schemas.
meta:
$ref: '#/components/schemas/Meta'
UniquenessType:
title: Uniqueness Type
description: This is used to denote the uniqueness type of the attribute.
enum:
- none
- server
- global
type: string
example: global
User:
title: User
description: Generic sample User. Not a real model used by any Cvent service.
required:
- userName
- emails
- name
- active
- userType
- locale
- groups
- timezone
- urn:ietf:params:scim:schemas:extension:enterprise:2.0:User
type: object
properties:
schemas:
type: array
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
readOnly: true
description: The list of schemas using this resource.
id:
type: string
description: A string that has to be a format matching the industry standard uuid.
format: uuid
readOnly: true
example: 3b2359a7-4583-40ed-8afd-67e5f15373d3
name:
$ref: '#/components/schemas/Name'
userName:
type: string
description: The user name of the user to be used during identification.
example: aMike@test.com
minLength: 1
maxLength: 50
active:
type: boolean
description: True indicates the user is active.
example: true
default: true
emails:
type: array
minItems: 1
description: 'The email of the user. The Cvent user can have only one email address.<br> If multiple email addresses
are provided, only one is accepted and rest are ignored. One email is selected based on the following sequence
of criteria: primary email, then work type, and finally first in the sequence.'
items:
$ref: '#/components/schemas/Email1'
title:
type: string
description: The title of the user.
example: Vice President
maxLength: 50
phoneNumbers:
type: array
description: The phone numbers of the user.<br> If more than one number per type is provided, only one is accepted
and rest are ignored.
items:
$ref: '#/components/schemas/PhoneNumber1'
addresses:
type: array
description: 'The address of the user. The user can have only one address. <br> If multiple addresses are provided,
only one is accepted and rest are ignored. One address is selected based on the following sequence of criteria:
primary, work type, first in the sequence'
items:
$ref: '#/components/schemas/Address6'
userType:
$ref: '#/components/schemas/UserType'
timezone:
type: string
description: List of <a href="#section/Getting-Started/Time-Zones">Timezones</a> supported.
minLength: 1
maxLength: 29
example: America/New_York
default: America/New_York
locale:
type: string
example: en-US
description: The locale of the user. The IETF Language Tag format is used.
minLength: 1
maxLength: 35
groups:
type: array
minItems: 1
description: The SCIM group (representing Cvent user role) of the user.
items:
$ref: '#/components/schemas/Group'
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:
$ref: '#/components/schemas/UserEnterpriseExtension'
meta:
$ref: '#/components/schemas/Meta'
Email1:
title: Email
description: Email
type: object
required:
- value
- type
- primary
properties:
type:
$ref: '#/components/schemas/EmailType1'
value:
type: string
description: The email of the user.
example: support@cvent.com
minLength: 1
maxLength: 80
primary:
type: boolean
description: True indicates the email is primary.
example: true
default: false
Mutability:
title: Mutability
description: This is used to denote the mutability of the attribute.
enum:
- readOnly
- readWrite
- immutable
- writeOnly
type: string
example: writeOnly
PhoneNumber1:
title: Phone Number
description: Phone Number
type: object
required:
- type
- value
properties:
type:
$ref: '#/components/schemas/PhoneType'
value:
type: string
description: The phone number of the user.
example: '+911234567890'
minLength: 1
maxLength: 30
AttributeDataType:
title: AttributeDataType
description: This is used to denote the type of the attribute.
enum:
- string
- boolean
- decimal
- integer
- dateTime
- reference
- complex
type: string
example: string
AuthenticationSchema:
title: Authentication Schema
description: Authentication Schema
type: object
properties:
name:
type: string
description: The name of the authentication.
example: OAuth Bearer Token
description:
type: string
description: The description of the authentication.
example: Authentication scheme using the OAuth Bearer Token Standard
specUri:
type: string
description: The location of the authentication specifications.
example: https://developers.cvent.com/documentation#section/Introduction
documentationUri:
type: string
description: The location of the API documentation.
example: https://developers.cvent.com/documentation#section/Introduction
type:
type: string
description: The type of the authentication.
example: oauthbearertoken
primary:
type: boolean
description: True indicates the authentication is primary.
example: true
ReferenceType:
title: Reference Type
description: This is used to denote the reference type of the attribute.
enum:
- User
- Group
- external
- uri
type: string
example: Group
Group-1:
title: Group
description: Generic sample name. Not a real model used by any Cvent service.
type: object
required:
- id
properties:
schemas:
type: array
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
readOnly: true
description: The list of schemas using this resource.
id:
type: string
description: The unique ID of the SCIM group.
format: uuid
readOnly: false
example: 3b2359a7-4583-40ed-8afd-67e5f15373d3
displayName:
type: string
description: The name of the user role.
example: Admin
meta:
$ref: '#/components/schemas/Meta'
ResourceTypes:
title: resourceTypes
description: Resource Types
type: object
properties:
schemas:
type: array
items:
type: string
example: urn:ietf:params:scim:api:messages:2.0:ListResponse
description: The collection of user schemas.
itemsPerPage:
type: integer
description: The number of schemas per page.
example: 50
startIndex:
type: integer
description: Starting index of the response.
example: 1
totalResults:
type: integer
description: The total count of schemas.
example: 5
Resources:
type: array
items:
$ref: '#/components/schemas/ResourceType'
description: The collection of schema resources.
ErrorResponse14:
title: ErrorResponse
description: The error response.
type: object
required:
- status
- detail
properties:
schemas:
type: array
items:
type: string
examp
# --- truncated at 32 KB (78 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cvent/refs/heads/main/openapi/cvent-user-scim-api-openapi.yml