OneTrust Platform — Access Management

{"openapi":"3.1.0","info":{"title":"Platform - Access Management","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"},"description":"The Access Management APIs enable you to programmatically control user access, manage organizational hierarchies, and monitor authentication activities across your OneTrust platform."},"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":"Audit Records","description":"APIs to manage and retrieve audit logs for user activities, including login history and access patterns. These endpoints help you monitor security events, track user authentication attempts, and maintain compliance with audit requirements.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"Audit Records"},{"name":"OAuth Token","description":"APIs to manage OAuth 2.0 authentication for secure API access. Generate access tokens using client credentials, retrieve token information, and manage API authentication for your applications.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"OAuth Token"},{"name":"Organizations","description":"APIs to manage your organizational hierarchy and structure. Create, update, and delete organizations, define parent-child relationships, and configure organization-specific settings such as default languages and approvers.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"Organizations"},{"name":"User Groups","description":"APIs to manage user groups and their memberships. Create groups to organize users, assign permissions collectively, add or remove members, and retrieve information about existing groups and their members.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"User Groups"},{"name":"User Groups V2","description":"APIs to manage user groups and their memberships. Create groups to organize users, assign permissions collectively, add or remove members, and retrieve information about existing groups and their members.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"User Groups V2"},{"name":"Users V2","description":"APIs to manage users and their memberships and access levels.","externalDocs":{"description":"OpenAPI 3.1.0 - Download Definition","url":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"x-displayName":"Users V2"}],"paths":{"/api/access/v1/external/organizations":{"get":{"operationId":"organizationTreeStructureUsingGET","summary":"Get List of Organizations","description":"Use this API to retrieve a list of all organizations within the organizational hierarchy.","tags":["Organizations"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_OrganizationExternalBasicDetailResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["ORGANIZATION"]}]},"post":{"operationId":"createOrganizationUsingPOST","summary":"Create Organization","description":"Use this API to create an organization within the organizational hierarchy.\n\n> 🗒 Things to Know\n>\n> - The organization will be created as a child of the organization specified in the `parentExternalId` parameter. If a `parentExternalId`value is not specified in the request, the organization will be created as a child of the root organization.","tags":["Organizations"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_OrganizationExternalRequest"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_OrganizationExternalResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_OrganizationExternalResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["ORGANIZATION"]}]}},"/api/access/v1/external/organizations/{externalId}":{"put":{"operationId":"updateOrganizationUsingPUT","summary":"Update Organization","description":"Use this API to update the details of an existing organization within the organizational hierarchy.","tags":["Organizations"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"externalId","in":"path","description":"The external identifier of the organization.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1},"example":"ABCDEF01"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_OrganizationExternalRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Invalid request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"},"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":[{"Platform-AccessManagement_OAUTH2":["ORGANIZATION"]}]},"delete":{"operationId":"deleteOrganizationPOST","summary":"Delete Organization","description":"Use this API to delete an existing organization and move its associated objects to a different organization.","tags":["Organizations"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"externalId","in":"path","description":"The external identifier of the organization.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1},"example":"ABCDEF01"},{"name":"targetExternalId","in":"query","description":"The external identifier of the organization that will receive all objects from the deleted organization.","required":true,"schema":{"type":"string","maxLength":100,"minLength":1},"example":"ABCDEF02"}],"responses":{"200":{"description":"OK"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"},"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":[{"Platform-AccessManagement_OAUTH2":["ORGANIZATION"]}]}},"/api/access/v1/login-history":{"get":{"operationId":"loginHistory","summary":"Get Audit Records for Login History","description":"Use this API to retrieve the login history of all users or a specific user for audit purposes.\n\n> 🗒 Things to Know\n>\n> - If a date range and specific `userId` is not specified in the request, the response will include the login history for all users over the past 7 days.\n> - If a date range is not specified but a specific `userId` is specified in the request, the response will include the login history for that specific user over the past 365 days.\n> - If a date range is specified but a specific `userId` is not specified in the request, the response will include the login history for all users over the specified date range.\n> - If the date range does not fall within the last 365 days, the response will return an error.","tags":["Audit Records"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"query","description":"The unique identifier of a specific user to filter login history.","required":false,"schema":{"type":"string","format":"uuid"},"example":"a7281178-7c90-421c-b4a1-57e39e3550a9"},{"name":"startDate","in":"query","description":"The start date for the login history search. Format: YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-01-01T00:00:00Z"},{"name":"endDate","in":"query","description":"The end date for the login history search. Format: YYYY-MM-DDTHH:MM:SSZ","required":false,"schema":{"type":"string","format":"date-time"},"example":"2022-12-31T23:59:59Z"},{"name":"page","in":"query","description":"The page number to retrieve.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PageLoginHistoryResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]}},"/api/access/v1/oauth/token":{"post":{"operationId":"GetOAuthToken","summary":"Generate Access Token","description":"Use this API to generate an OAuth access token using the `client_credentials` grant type.\n\n> 🗒 Things to Know\n>\n> - Client credentials can be generated from within Global Settings in the OneTrust application. For more information, see [Managing OAuth 2.0 Client Credentials](/onetrust/docs/managing-oauth-20-client-credentials).\n> - Use the `client_id` and `client_secret` to generate the OAuth access token using this API.\n> - A maximum of 500 OAuth 2.0 client credentials can be created per account.","tags":["OAuth Token"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_ClientCredentialsRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_ClientCredentialsResponse"},"example":{"access_token":"eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJyb2xlIjoiQXBpIEtleSBVc2VyIiwidXNlcl9uYW1lIjoiMGI2ZDRlMjI3ZDAxNGM5YzkwZjdkOWE1NGZjOTVjOTVAYXBpLm9uZXRydXN0LmNvbSIsImxhbmd1YWdlSWQiOjEsInNlc3Npb25JZCI6ImRlOGEzZDUxLTFiMTYtNGM5ZS1hODNhLWZkZDUwOWI4YmNiZSIsInRlbmFudEd1aWQiOiIwYjZkNGUyMi03ZDAxLTRjOWMtOTBmNy1kOWE1NGZjOTVjOTUiLCJjbGllbnRfaWQiOiIzMWJiMjBmOGUzYjU0N2YwYjc1MzY2NWVjODMxNmFkYyIsIm9yZ0dyb3VwSWQiOiJjZjQzMTljMi03MmQ1LTRlMjgtOGIwNy1kY2FhMmI3YTBkYzUiLCJvcmdHcm91cEd1aWQiOiJjZjQzMTljMi03MmQ1LTRlMjgtOGIwNy1kY2FhMmI3YTBkYzUiLCJvdC1zY29wZXMiOiJBU1NFU1NNRU5ULEFTU0VTU01FTlRfUkVBRCxDT05TRU5ULENPTlNFTlRfUkVBRCxDT05UUk9MLENPT0tJRSxDT09LSUVfUkVBRCIsInNjb3BlIjpbInJlYWQiXSwidGVuYW50SWQiOjM2LCJndWlkIjoiMGRmY2RiMjItZGNlNS00NWI5LWJlYTctNmNmZTQwMGFkZDJkIiwiZXhwIjoxNjM5MjU5Nzg4LCJqdGkiOiIwNzE1OGVkYi1mZjdkLTRkZjktYjQxYS0xZTRhMjgzZmE3N2EiLCJlbWFpbCI6IjBiNmQ0ZTIyN2QwMTRjOWM5MGY3ZDlhNTRmYzk1Yzk1QGFwaS5vbmV0cnVzdC5jb20ifQ.Hrzgo-vEE073wxkXtJDLKGRjAr2iT4G3EsyISr7x1brLLUuAojWWEGO1ue4RWfntUjEDYC9UAxpMbuP2Xv5ymqUartufj6YwamAqKdGd9gijaoGTXSNvE6ALSCqGOz8owpjh10Qu7nmBnSfzvmkSAD0dJKofJGvGd6IUC21eAU9rcX16R7hbGdmvSWtX7pzjwrZ72CcnLtwCSg7-XJhNB24dY_-iaftBu_vsw3Lr6nddMOGMfXtUl8bPN_ptmXcF4bA-7y2Vw7xEKYVKreKuQsiMAJ2a2aKiRVmHE1RFbyp2R-Z2soqkUL_DQxKZMeU9ehX8NDcmZ_JmtzemgeaoPQ","email":"0b6d4e227d014c9c90f7d9a54fc95c95@api.onetrust.com","expires_in":31535999,"guid":"0dfcdb22-dce5-45b9-bea7-6cfe400add2d","jti":"U3TACUsO6qB_19J1ueRBUGqXRL0","languageId":1,"orgGroupGuid":"cf4319c2-72d5-4e28-8b07-dcaa2b7a0dc5","orgGroupId":"cf4319c2-72d5-4e28-8b07-dcaa2b7a0dc5","ot-scopes":"ASSESSMENT,ASSESSMENT_READ,ATTACHMENT,ATTACHMENT_READ,AUDIT_MANAGEMENT,CONSENT,CONSENT_READ,CONTROL,COOKIE,COOKIE_READ,DATA_CATALOG_READ,DATA_DISCOVERY,DSAR_READ,DSAR_WRITE,INCIDENT,INCIDENT_CREATE,INCIDENT_READ,INTEGRATIONS,INVENTORY,INVENTORY_READ,INVENTORY_WRITE,ITRM,ORGANIZATION,POLICY,RISK,SCIM,USER,VRM,VRM_READ","role":"Api Key User","scope":"read","sessionId":"de8a3d51-1b16-4c9e-a83a-fdd509b8bcbe","tenantGuid":"0b6d4e22-7d01-4c9c-90f7-d9a54fc95c95","tenantId":36,"token_type":"bearer","user_name":"0b6d4e227d014c9c90f7d9a54fc95c95@api.onetrust.com"}}}},"400":{"description":"Bad Request\n\n### Possible Reasons:\n* Invalid `grant_type`\n"},"401":{"description":"Unauthorized\n\n### Possible Reasons:\n* Invalid client credentials\n"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"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"}}}},"/api/access/v1/user-groups":{"get":{"operationId":"retrieveUserGroupsUsingGET","summary":"Get List of User Groups","description":"Use this API to retrieve a list of user groups.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"filters","in":"query","description":"Filter criteria for the results.","required":false,"schema":{"type":"string"},"example":"name:Administrators"},{"name":"page","in":"query","description":"The page number to retrieve.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sort order for the results.","schema":{"type":"string","default":"name,asc","enum":["name,asc","name,desc","description,asc","description,desc","createdDate,asc","createdDate,desc","lastModifiedDate,asc"]},"example":"name,asc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PageUserGroupResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]},"post":{"operationId":"createUserGroupUsingPOST","summary":"Create User Group","description":"Use this API to create a new user group.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_CreateGroupRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"201":{"description":"Created","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]}},"/api/access/v1/user-groups/{userGroupId}":{"put":{"operationId":"updateUserGroupUsingPUT","summary":"Update User Group","description":"Use this API to update the name and description of a specific user group.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userGroupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UpdateGroupRequest"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"400":{"description":"Bad request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User group not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]},"delete":{"operationId":"deleteUserGroupUsingDELETE","summary":"Delete User Group","description":"Use this API to delete an existing user group.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userGroupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User group not found"},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]}},"/api/access/v1/user-groups/{userGroupId}/members":{"get":{"operationId":"retrieveMembersUsingGET","summary":"Get User Group Members","description":"Use this API to retrieve a list of users that are members of a specific user group.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userGroupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"},{"name":"page","in":"query","description":"The page number to retrieve.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"Sort order for the results.","schema":{"type":"string","default":"fullName,asc","enum":["fullName,asc","fullName,desc","memberId, asc","memberId, desc","email,asc","email,desc","enabled,asc","enabled,desc","createdBy,asc","createdBy,desc","createdDate,asc","createdDate,desc"]},"example":"fullName,asc"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PageMemberResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User group not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PageMemberResponse"}}}},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]},"post":{"operationId":"addMembersUsingPOST","summary":"Add Members to User Group","description":"Use this API to add users as members of a specific user group. \n\n> 🗒 Things to Know\n>\n> - When a user is added as a member of a user group, the user inherits the role and organization configured for that user group. If the user belongs to other user groups, the user will still retain existing membership with those groups in addition to their other existing roles and permissions.\n> - The `userId` of the users to be added to the user group can be specified in the request body in a comma separated list.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userGroupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_AddMembersRequest"}}}},"responses":{"201":{"description":"Created"},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User group not found"},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]},"delete":{"operationId":"removeMembersUsingDELETE","summary":"Remove Members from User Group","description":"Use this API to remove users as members of a specific user group.\n\n> 🗒 Things to Know\n>\n> - The `userId` of the users to be removed from the user group can be specified in the request body in a comma separated list.","tags":["User Groups"],"x-onetrust":{"spec-label":"https://developer.onetrust.com/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userGroupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_DeleteMembersRequest"}}}},"responses":{"204":{"description":"No Content"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"User group not found"},"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":[{"Platform-AccessManagement_OAUTH2":["USER"]}]}},"/api/access/v2/user-groups":{"get":{"operationId":"getAllUserGroupWithFiltersV2","summary":"Get List of User Groups","description":"Use this API to retrieve a list of user groups, with support for pagination and f

# --- truncated at 32 KB (112 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onetrust/refs/heads/main/openapi/onetrust-platform-access-management-openapi.json