{ "opencollection": "1.0.0", "info": { "name": "Cvent REST APIs — Event Cloud User SCIM API", "version": "ea" }, "items": [ { "info": { "name": "User SCIM", "type": "folder" }, "items": [ { "info": { "name": "Get SCIM Groups", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/Groups", "params": [ { "name": "startIndex", "value": "", "type": "query", "description": "Starting index of the response." }, { "name": "count", "value": "", "type": "query", "description": "The count of records to be retrieved in a response." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a paginated list of SCIM groups (representing Cvent user roles) in an account." }, { "info": { "name": "List Resource Types", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/ResourceTypes", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a list of resource types." }, { "info": { "name": "Get Resource Type", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/ResourceTypes/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for a resource." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the details of a single resource type." }, { "info": { "name": "List Schemas", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/Schemas", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the paginated list of user schemas and its extension models representing the user and SCIM groups (representing Cvent user roles)." }, { "info": { "name": "Get Schema", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/Schemas/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for a schema." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the details of a user schema and its extension models representing the user and SCIM groups (representing Cvent user roles)." }, { "info": { "name": "Get Service Provider Config", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/ServiceProviderConfig", "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets Cvent's configurations of SCIM." }, { "info": { "name": "List Users", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/Users", "params": [ { "name": "startIndex", "value": "", "type": "query", "description": "Starting index of the response." }, { "name": "count", "value": "", "type": "query", "description": "The count of records to be retrieved in a response." }, { "name": "filter", "value": "", "type": "query", "description": "Use filter query parameters to limit results\nto data that matches your criteria. See\n[Filters](https://developers.cvent.com/docs/rest-api/reference/filters) for details.\n\nSupported fields and operators are listed below:\n\n| Field | Operators |\n|-------------------|------------------------------------|\n| userName | `eq`, `ne` |\n| groups.value | `eq`, `ne` |\n| active | `eq`, `ne` |\n| id | `eq`, `ne` |\n| emails.value | `eq`, `ne` |\n| meta.lastModified | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |\n| meta.created | `eq`, `ne`, `lt`, `le`, `gt`, `ge` |\n\nThe following logical operators are supported for combining filters:\n* and\n* or\n" } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets a list of users." }, { "info": { "name": "Create User", "type": "http" }, "http": { "method": "POST", "url": "https://api-platform.cvent.com/ea/scim/v2/Users", "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Get User", "type": "http" }, "http": { "method": "GET", "url": "https://api-platform.cvent.com/ea/scim/v2/Users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for a user." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Gets the details of a single user." }, { "info": { "name": "Update User", "type": "http" }, "http": { "method": "PUT", "url": "https://api-platform.cvent.com/ea/scim/v2/Users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for a user." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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." }, { "info": { "name": "Delete User", "type": "http" }, "http": { "method": "DELETE", "url": "https://api-platform.cvent.com/ea/scim/v2/Users/:id", "params": [ { "name": "id", "value": "", "type": "path", "description": "Unique ID for a user." } ], "auth": { "type": "oauth2", "flow": "client_credentials", "accessTokenUrl": "https://api-platform.cvent.com/ea/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "Deletes a user." } ] } ], "bundled": true }