OneTrust supports cross-domain identity management through the SCIM 2.0 specification. System for Cr oss-Domain Identity Management (SCIM) is an open specification to help facilitate the automated mana gement of user identities and groups in cloud applications using RESTful APIs. This allows organizat ions to manage and update user information and group information across domains and applications. (2 6 operations.)
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/platform-user-provisioning"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.1.0","info":{"title":"Platform - User Provisioning","description":"OneTrust supports cross-domain identity management through the SCIM 2.0 specification. System for Cross-Domain Identity Management (SCIM) is an open specification to help facilitate the automated management of user identities and groups in cloud applications using RESTful APIs. This allows organizations to manage and update user information and group information across domains and applications.","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my.onetrust.com/s/contactsupport"},"license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0"}},"servers":[{"url":"https://{hostname}","variables":{"hostname":{"default":"hostname","description":"The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com."}}}],"tags":[{"name":"Groups V2","description":"V2 version APIs to manage Groups.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"Resources V3","description":"V3 version APIs to manager Resources Type.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"SCIM Schemas V3","description":"V3 version APIs to manager Schemas.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"Service Provider V3","description":"V3 version APIs to manager the Service Provider.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"User Groups V3","description":"V3 version APIs to manager User Groups.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"Users V2","description":"V2 version APIs to manage Users.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}},{"name":"Users V3","description":"V3 version APIs to manager Users.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"}}],"x-onetrust":{"spec-label":"OpenAPI 3.1.0","links":["{'SCIM User & Group Provisioning': 'https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad?topicId=0TO1Q000000ItSxWAK'}"]},"x-readme":{"explorer-enabled":false,"proxy-enabled":false,"metrics-enabled":false},"paths":{"/api/scim/v2/Groups":{"get":{"operationId":"listGroupsUsingGET","summary":"Get List of Groups","description":"Use this API to retrieve a list of SCIM groups from your account. The response will include each unique role-organization combination. For example, if your account has 20 roles and 2 organizations, this API will return 40 unique SCIM groups in the response. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n","tags":["Groups V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"startIndex","in":"query","description":"Start index of the groups to be fetched. Minimum and the default values are 1.","schema":{"type":"string","default":"1","minimum":1},"example":"1"},{"name":"count","in":"query","description":"The number of groups to be returned. The default value is 25 and the maximum number of groups returned are 25.","schema":{"type":"string","default":"25","maximum":25,"minimum":1},"example":"25"}],"responses":{"200":{"description":"OK\n\nGroups retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION"]}]}},"/api/scim/v2/Groups/{groupId}":{"get":{"operationId":"getGroupResourceUsingGET","summary":"Get Group","description":"Use this API to retrieve details for a specific SCIM group. The response will include details such as the created date, last modified date, and list of users within the SCIM group. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n","tags":["Groups V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"groupId","in":"path","description":"ID that uniquely identifies the SCIM group. The `groupId` can be obtained using the [Get List of Groups]\n(/onetrust/reference/listgroupsusingget) API.\n","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"},{"name":"excludedAttributes","in":"query","description":"The parameter to exclude the list of group members from the response when retrieving details of a specific group.","required":false,"schema":{"type":"string","enum":["members"],"maxLength":255}}],"responses":{"200":{"description":"OK\n\nGroup retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION"]}]},"put":{"operationId":"updateGroupMembersUsingPUT","summary":"Update Group","description":"Use this API to fully update SCIM group details and SCIM group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - When a user is added as a member of a SCIM group, the user is provisioned with that specific role-organization combination. If the user belongs to other SCIM groups, the user will still retain existing membership with those groups as users can be assigned to multiple roles and multiple organizations.\n> - When this API is called, the existing list of users that are members of the SCIM group will be replaced with the new list of users defined in the request. If no users are specified, the existing list of users will be removed from the SCIM group.\n","tags":["Groups V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"groupId","in":"path","description":"ID that uniquely identifies the SCIM group. The `groupId` can be obtained using the [Get List of Groups](/onetrust/reference/listgroupsusingget) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResource"}}}},"responses":{"200":{"description":"OK\n\nGroup members updated successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GroupResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION"]}]},"patch":{"operationId":"updateGroupMembersUsingPATCH","summary":"Modify Group","description":"Use this API to partially update SCIM group details and/or SCIM group membership. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n> \n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - When a user is added as a member of a SCIM group, the user is provisioned with that specific role-organization combination. If the user belongs to other SCIM groups, the user will still retain existing membership with those groups as users can be assigned to multiple roles and multiple organizations.\n","tags":["Groups V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"groupId","in":"path","description":"ID that uniquely identifies the SCIM group. The `groupId` can be obtained using the [Get List of Groups]\n(/onetrust/reference/listgroupsusingget) API.\n","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchGroupResourceRequest"}}}},"responses":{"204":{"description":"OK\n\nGroup members updated successfully."},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION"]}]}},"/api/scim/v2/Users":{"get":{"operationId":"getAllUsersUsingGET","summary":"Get List of Users","description":"Use this API to retrieve a list of users along with user details such as the created date, last modified date, name, and email. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - OneTrust supports the use of SCIM filters to identify specific users:\n> - Filters can be applied on the `id`, `externalId`, `email`, `emails`, `givenName`, `familyName`, `userType`, and `active` attributes.\n> - The supported logical operators are `eq` (equal), `co` (contains), `sw` (starts with), `gt` (greater than), `ge` (greater than or equal to), `lt` (less than), and `le` (less than or equal to).\n> - The `filter` query parameter is applied in the following format: attribute operator \"value\". For example, emails co \"onetrust.com\" would return a list of user records that contain emails with the onetrust.com domain.\n","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"startIndex","in":"query","description":"Start index of the users to be retrieved.","schema":{"type":"string","default":"1","minimum":1}},{"name":"count","in":"query","description":"The number of users to be returned. ","schema":{"type":"string","default":"25","minimum":1}}],"responses":{"200":{"description":"OK\n\nUsers retrieved successfully.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]},"post":{"operationId":"createUserUsingPOST","summary":"Create User","description":"Use this API to create a user and associate that user with the configured organization and role. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - If a value is not provided for `roles` or `organization` in the request, the newly created user will be assigned the default role and organization as configured on the **User Provisioning** screen within **Global Settings** in the OneTrust application.\n> - This API supports assigning the user to multiple roles within one organization. If the user should be assigned to other role-organization combinations (SCIM groups), use the [Modify Group Members](https://developer.onetrust.com/onetrust/reference/updategroupmembersusingpatch) API.\n","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]}},"/api/scim/v2/Users/{id}":{"get":{"operationId":"getUserUsingGET","summary":"Get User","description":"Use this API to retrieve the details of a specific user. The response will include details such as the created date, emails, and SCIM groups to which the user belongs. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the user","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"200":{"description":"OK\n\nUser retrieved successfully.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]},"put":{"operationId":"updateUserUsingPUT","summary":"Update User","description":"Use this API to fully update all attributes for a user. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - The following user attributes will be updated using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `userType`, `employeeNumber`, `department`, `manager`, and `title`.\n> - Any attributes not included in the request will be replaced with a `null` value. It is best to first retrieve the latest user record using the [Get User](https://developer.onetrust.com/onetrust/reference/getuserusingget) API, and then modify that response to use in the request for this API. If you only need to update some but not all attributes, use the [Modify User](https://developer.onetrust.com/onetrust/reference/patchuserusingpatch) API.\n","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the user","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]},"delete":{"operationId":"deleteUserUsingDELETE","summary":"Delete User","description":"The Delete User feature is not available at this time.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"id","in":"path","description":"ID that uniquely identifies a user. The `id` can be obtained using the [Get List of Users](/onetrust/reference/getallusersusingget) API.","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]},"patch":{"operationId":"patchUserUsingPATCH","summary":"Modify User","description":"Use this API to activate a user, deactivate a user, or partially update a user's attributes. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see [Legacy SCIM User Provisioning](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n> - The following user attributes can be modified using this API: `givenName`, `familyName`, `externalId`, `active`, `division`, `userType`, `employeeNumber`, `department`, `manager`, and `title`.\n","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"id","in":"path","description":"Unique identifier of the user","required":true,"schema":{"type":"string","format":"uuid"},"example":"550e8400-e29b-41d4-a716-446655440000"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PatchUserResourceRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResource"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"description":"The number of requests allowed within the specified period.","format":"int32"}}}},"500":{"description":"Internal Server Error"}},"security":[{"OAUTH2":["SCIM","INTEGRATION","USER"]}]}},"/api/scim/v3/Groups":{"get":{"operationId":"getGroups","summary":"Get List of User Groups","description":"Use this API to retrieve a list of user groups. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.\n\n> 🗒 Things to Know\n>\n> - This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see [SCIM User & Group Provisioning](https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad).\n> - OneTrust supports the use of SCIM filters to identify specific user groups:\n> - Filters can be applied on the `displayName` attribute.\n> - The supported logical operators are `eq` (equal) and `co` (contains).\n> - The `filter` query parameter is applied in the following format: attribute operator \"value\". For example, displayName co \"Sales\" would return a list of user group records that contain sales in the display name.\n","tags":["User Groups V3"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json"},"parameters":[{"name":"startIndex","in":"query","description":"Starting value of the response.","schema":{"type":"string","default":"1","minimum":1}},{"name":"count","in":"query","description":"The number of entries to be returned in the response.","schema":{"type":"string","default":"25","maximum":25,"minimum":1}},{"name":"excludedAttributes","in":"query","description":"Use this parameter to exclude members available in the Group in the response.","schema":{"type":"string","default":"members"}},{"name":"filter","in":"query","description":"Use this parameter to filter the list of groups based on `displayName` using the `eq` or `co` operators.","schema":{"type":"string","default":"displayName co \"Sales\""}}],"responses":{"200":{"description":"OK\n\nGroups retrieved successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).","headers":{"Retry-After":{"schema":{"description":"The number of seconds after which requests will be allowed again.","format":"int32"}},"ot-period":{"schema":{"description":"The unit of time for which the rate limit applies","enum":["HOUR","MINUTE"]}},"ot-ratelimit-event-id":{"schema":{"description":"The unique identifier for the rate-limiting event.","format":"uuid"}},"ot-request-made":{"schema":{"description":"The number of requests made within the specified period.","format":"int32"}},"ot-requests-allowed":{"schema":{"de
# --- truncated at 32 KB (88 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-platform-user-provisioning-openapi.json