{"openapi":"3.1.0","info":{"title":"Platform - Access Management","version":"1.0","contact":{"name":"OneTrust Support","url":"https://my-onetrust-com.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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.proxy.uchicago.edu/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 filtering.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"page","in":"query","description":"The page number for the results to be retrieved.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records to be retrieved per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sorting criteria in the format: `property,(asc|desc)`. The default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"name,asc","enum":["name,asc","name,desc","description,asc","description,desc","createdDate,asc","createdDate,desc","lastModifiedDate,asc"]},"example":"name,asc"},{"name":"filters","in":"query","description":"The filters to apply to the user groups.","schema":{"type":"string"},"examples":{"Contains filter":{"summary":"Filter by name containing value 'ministr'. Value should prefixed and suffixed by % characters","description":"Contains filter","value":"name=~=%ministr% "},"Equal to filter":{"summary":"Filter by name equal to 'Administrators'","description":"Equal to filter","value":"name==Administrators"},"Starts with filter":{"summary":"Filter by name starting with 'Admin'. Value should suffixed by % character","description":"Starts with filter","value":"name=sw=Admin%"},"Ends with filter":{"summary":"Filter by name ending with 'tors'. Value should prefixed by % character","description":"Ends with filter","value":"name=ew=%tors"}}}],"responses":{"200":{"description":"User groups retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PagePublicUserGroupResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"createUserGroupV2","summary":"Create User Group","description":"Use this API to create a new user group with a specified name and description.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicCreateGroupRequest"}}}},"responses":{"201":{"description":"User group created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicUserGroupResponse"}}}},"400":{"description":"Invalid request data"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/{groupId}":{"get":{"operationId":"getUserGroupByIdV2","summary":"Get User Group","description":"Use this API to retrieve a specific user group by its unique identifier.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"200":{"description":"User group retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicUserGroupResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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"]}]},"put":{"operationId":"updateUserGroupByIdV2","summary":"Update User Group","description":"Use this API to update the attributes of an existing user group by its unique identifier.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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_PublicUpdateGroupRequest"}}}},"responses":{"200":{"description":"User group attributes by identifier is successfully updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicUserGroupResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"409":{"description":"User group name conflict"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"deleteUserGroupByIdV2","summary":"Delete User Group","description":"Use this API to delete an existing user group by its unique identifier.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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":"User group by identifier deleted successfully"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/{groupId}/access-levels":{"get":{"operationId":"getAccessLevelsForUserGroupByIdV2","summary":"Get User Group Roles","description":"Use this API to retrieve a list of roles for a specific user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"200":{"description":"Access levels retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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"]}]},"put":{"operationId":"updateAccessLevelForUserGroupByIdV2","summary":"Update User Group Roles","description":"Use this API to update the roles of a user group by replacing the current set of roles with a new one.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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_PublicAccessLevelUpdateDto"}}}},"responses":{"204":{"description":"Access level updated successfully"},"400":{"description":"Invalid request data"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"addAccessLevelsForUserGroupByIdV2","summary":"Add User Group Roles","description":"Use this API to add a new role to a user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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_PublicAccessLevelRequest"}}}},"responses":{"201":{"description":"Access level added successfully"},"400":{"description":"Invalid request data"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"removeAccessLevelForUserGroupByIdV2","summary":"Remove User Group Roles","description":"Use this API to remove roles from a specific user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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":{"description":"List of access levels to remove","type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelRequest","minItems":1},"minItems":1}}}},"responses":{"204":{"description":"Access levels removed successfully"},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/{groupId}/members":{"get":{"operationId":"getMembersFromAUserGroupByIdV2","summary":"Get List of Users in User Group","description":"Use this API to retrieve a paginated list of members in a specified user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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 for the results to be retrieved.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records to be retrieved per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sorting criteria in the format: `property,(asc|desc)`. The default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"name,asc","enum":["name,asc","name,desc"]},"example":"name,asc"}],"responses":{"200":{"description":"Members retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PagePublicMemberResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"addMultipleMembersForUserGroupByIdV2","summary":"Add Multiple Users to User Group","description":"Use this API to add multiple users to a specified user group in bulk.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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_PublicAddMembersRequest"}}}},"responses":{"201":{"description":"Members added successfully"},"400":{"description":"Invalid request data (e.g., empty member list)"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"removeMultipleMembersForUserGroupByIdV2","summary":"Remove Multiple Users from User Group","description":"Use this API to remove multiple users from a specified user group in bulk.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","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_PublicDeleteMembersRequest"}}}},"responses":{"204":{"description":"Members removed successfully"},"400":{"description":"Invalid request data (e.g., empty member list)"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/{groupId}/members/{memberId}":{"post":{"operationId":"addAMemberForUserGroupByIdV2","summary":"Add User to User Group","description":"Use this API to add a single user to a specified user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"},{"name":"memberId","in":"path","description":"The unique identifier of the user to be added to the group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"201":{"description":"Member added successfully"},"400":{"description":"Invalid request data (e.g., invalid UUID format)"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group or member not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"removeAMemberForUserGroupByIdV2","summary":"Remove User from User Group","description":"Use this API to remove a single user from a specified user group.","tags":["User Groups V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"groupId","in":"path","description":"The unique identifier of the user group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"},{"name":"memberId","in":"path","description":"The unique identifier of the user to be removed from the group.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"204":{"description":"Member removed successfully"},"400":{"description":"Invalid request data (e.g., invalid UUID format)"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User group or member not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/users":{"get":{"operationId":"getAllUserDetailsV2","summary":"Get List of Users","description":"Use this API to retrieve a list of all users in your account.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"page","in":"query","description":"The page number for the results to be retrieved.","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"The number of records to be retrieved per page.","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20},{"name":"sort","in":"query","description":"The sorting criteria in the format: `property,(asc|desc)`. The default sort order is ascending. Multiple sort criteria are supported.","schema":{"type":"string","default":"name,asc","enum":["name,asc","name,desc","email,asc","email,desc","organizationname,asc","organizationname,desc"]},"example":"name,asc"}],"responses":{"200":{"description":"User details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PagePublicOrgUserDetailsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"createUserV2","summary":"Create User","description":"Use this API to create a new user in your account.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicOrgUserCreateRequest"}}}},"responses":{"201":{"description":"User created successfully","content":{"application/json":{"schema":{"description":"Identifier of the newly created user","type":"string"}}}},"400":{"description":"Invalid request data"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/users/{userId}":{"get":{"operationId":"getUserV2","summary":"Get User","description":"Use this API to retrieve details for a single user in your account.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"200":{"description":"User retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicOrgUserDetailsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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"]}]},"put":{"operationId":"updateUserV2","summary":"Update User","description":"Use this API to update the details for a single user in your account.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","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_PublicOrgUserUpdateRequest"}}}},"responses":{"200":{"description":"User updated successfully"},"400":{"description":"Invalid request data"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/users/{userId}/access-levels":{"get":{"operationId":"getUserAccessLevelsV2","summary":"Get User Roles","description":"Use this API to retrieve a list of roles assigned to a specific user.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}],"responses":{"200":{"description":"User access levels retrieved successfully","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelResponse"}}}}},"400":{"description":"Bad Request"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"User not found"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"addUserAccessLevelV2","summary":"Add User Role","description":"Use this API to add a new role to a specific user.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","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_PublicAccessLevelRequest"}}}},"responses":{"201":{"description":"Access level added successfully"},"400":{"description":"Invalid request data - malformed UUID, invalid request body, attempting to add INVITED role, or user already has access level in the specified organization"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"Organization or role not found"},"409":{"description":"Conflict - User does not exist"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":"removeUserAccessLevelV2","summary":"Remove User Role","description":"Use this API to remove a specific role from a user.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","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_PublicAccessLevelRequest"}}}},"responses":{"204":{"description":"Access level removed successfully"},"400":{"description":"Invalid request data - malformed UUID, invalid request body, removal would leave user with no roles in default organization, or removal would leave no site admins in root organization"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"404":{"description":"Organization, role or access level not found"},"409":{"description":"Conflict - User does not exist"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/users/{userId}/default-organization":{"patch":{"operationId":"setUserDefaultOrganizationV2","summary":"Modify User Default Organization","description":"Use this API to modify the default organization for a specific user. The user must have at least one role in the specified organization.","tags":["Users V2"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"string","format":"uuid"},"example":"c01233a5-482c-4274-8f88-15e24c1c96a4"},{"name":"organizationId","in":"query","description":"The unique identifier of the organization to set as default.","required":true,"schema":{"type":"string","format":"uuid"},"example":"d01233a5-482c-4274-8f88-15e24c1c96a5"}],"responses":{"204":{"description":"Default organization updated successfully"},"400":{"description":"Invalid request – User does not have access to the specified organization"},"401":{"description":"Unauthorized - Invalid or missing authentication"},"403":{"description":"Forbidden - Insufficient permissions"},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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/audit/v1/users/{userId}/activities":{"get":{"operationId":"userActivity","summary":"Get Audit Records for User's Profile","description":"Use this API to retrieve a list of changes made to a user's profile for audit purposes. The response will include a history of changes made to the user's details, roles, and organizations.","tags":["Audit Records"],"x-onetrust":{"spec-label":"https://developer-onetrust-com.proxy.uchicago.edu/onetrust/openapi/platform-access-management.json"},"parameters":[{"name":"userId","in":"path","description":" >-\n `userId` can be retireved using the [Retrieve list of\n Users](https://{$$.env.developer}/api-reference/general/user-provisioning/user-provisioning-apis/users/getallusersusingget)\n API\n\n","required":true,"schema":{"type":"string","format":"uuid","example":"c01233a5-482c-4274-8f88-15e24c1c96a4"}},{"name":"includeChildObjects","in":"query","description":"Whether to include child object activities","required":false,"schema":{"type":"boolean","default":false},"example":false},{"name":"page","in":"query","description":"Results page to be retrieved (0..N). Example- '?page=1","schema":{"type":"integer","format":"int32","default":0,"minimum":0},"example":1},{"name":"size","in":"query","description":"Number of records per page (1…N).","schema":{"type":"integer","format":"int32","default":20,"maximum":2000,"minimum":1},"example":20}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuditRecords_PageUserActivityResponse"}}}},"400":{"description":"Invalid user ID format","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuditRecords_PageUserActivityResponse"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Access denied","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuditRecords_PageUserActivityResponse"}}}},"404":{"description":"User not found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AuditRecords_PageUserActivityResponse"}}}},"429":{"description":"Too Many Requests. \nFor more information, see [API Rate Limits](https://developer-onetrust-com.proxy.uchicago.edu/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":[{"AuditRecords_OAUTH2":["USER"]}]}}},"components":{"schemas":{"Platform-AccessManagement_PublicAccessLevelCreateRequest":{"type":"object","properties":{"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"323e4567-e89b-12d3-a456-426614174000"},"roleIds":{"description":"The list of role identifiers to be associated with the organization.","type":"array","items":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","minItems":1},"minItems":1,"uniqueItems":true},"defaultOrganization":{"description":"The indicator of whether the provided organization will be treated as the default organization.","type":"boolean","example":true,"default":"false"}},"required":["organizationId"]},"Platform-AccessManagement_PublicOrgUserUpdateRequest":{"type":"object","properties":{"firstName":{"description":"The first name of the user.","type":"string","example":"Michael","maxLength":100,"minLength":0},"lastName":{"description":"The last name of the user.","type":"string","example":"Douglas","maxLength":100,"minLength":0},"internal":{"description":"The indicator of whether the user is an internal user.","type":"boolean","example":true,"default":"false"},"expirationDateTime":{"description":"User expiration date in the system","type":"string","format":"date-time","example":"2029-05-01T12:34:56Z"},"externalId":{"description":"The external identifier for the user.","type":"string","example":"1A2234-abc","maxLength":128,"minLength":0},"accessLevels":{"type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelCreateRequest"},"minItems":1,"uniqueItems":true}},"required":["firstName","lastName"]},"Platform-AccessManagement_PublicUserGroupResponse":{"type":"object","properties":{"id":{"description":"The internal identifier of the user group.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The name of the user group.","type":"string","example":"My User Group","maxLength":100},"description":{"description":"The description of the user group.","type":"string","example":"User group used for grouping users","maxLength":300},"createdBy":{"description":"The unique identifier of the user who created the user group.","type":"string","format":"uuid","example":"52b6b7df-9e69-4d6f-9fd3-75c1d4626366"},"createdDate":{"description":"The timestamp of when the user group was created.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"},"lastModifiedBy":{"description":"The unique identifier of the user who last modified the user group.","type":"string","format":"uuid","example":"52b6b7df-9e69-4d6f-9fd3-75c1d4626366"},"lastModifiedDate":{"description":"The timestamp of when the user group was last modified.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"}}},"Platform-AccessManagement_PublicUpdateGroupRequest":{"type":"object","properties":{"name":{"description":"The name of the user group.","type":"string","example":"My User Group","maxLength":100,"minLength":1},"description":{"description":"The description of the user group.","type":"string","example":"User group used for grouping users","maxLength":300}},"required":["name"]},"Platform-AccessManagement_PublicAccessLevelUpdateDto":{"type":"object","properties":{"currentOrganizationId":{"description":"The unique identifier of the organization currently associated with the user group.","type":"string","format":"uuid","example":"323e4567-e89b-12d3-a456-426614174000"},"currentRoleId":{"description":"The unique identifier of the role currently associated with the user group.","type":"string","format":"uuid","example":"823e4567-e89b-12d3-a456-426614174000"},"newOrganizationId":{"description":"The unique identifier of the replacement organization.","type":"string","format":"uuid","example":"923e4567-e89b-12d3-a456-426614174000"},"newRoleId":{"description":"The unique identifier of the replacement role.","type":"string","format":"uuid","example":"813e4567-e89b-12d3-a456-426614174000"}},"required":["currentOrganizationId","currentRoleId","newOrganizationId","newRoleId"]},"Platform-AccessManagement_UpdateGroupRequest":{"type":"object","properties":{"name":{"description":"The name of the user group.","type":"string","example":"Administrators","maxLength":100,"minLength":1},"description":{"description":"A brief description of the user group.","type":"string","example":"Group for system administrators","maxLength":300}}},"Platform-AccessManagement_UserGroupResponse":{"type":"object","properties":{"userGroupId":{"description":"The unique identifier of the user group.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"name":{"description":"The name of the user group.","type":"string","example":"Administrators","maxLength":100,"minLength":1},"description":{"description":"The brief description of the user group.","type":"string","example":"Group for system administrators","maxLength":250},"createdBy":{"description":"The unique identifier of the user who created this record.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"createdDate":{"description":"The date and time the record was created.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"},"lastModifiedBy":{"description":"The unique identifier of the user who last modified the record.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"lastModifiedDate":{"description":"The date and time the record was last modified.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"}}},"Platform-AccessManagement_OrganizationExternalRequest":{"type":"object","properties":{"externalId":{"description":"The external identifier of the organization. Accepts alphanumeric characters, underscores, periods, colons, and hyphens.","type":"string","example":"ext-org-123","maxLength":100,"minLength":1},"parentExternalId":{"description":"The external identifier of the parent organization.","type":"string","example":"ext-org-parent-456","maxLength":100},"parentOrganizationId":{"description":"The unique identifier of the parent organization.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174002"},"defaultLanguageCode":{"description":"The ISO language code for the organization's default language (for example: en, fr, de, es, zh).","type":"string","example":"en","maxLength":10,"minLength":2},"name":{"description":"The name of the organization.","type":"string","example":"OneTrust","maxLength":100,"minLength":1},"defaultApprover":{"description":"The email address of the default approver for the organization.","type":"string","format":"email","example":"approver@onetrust.com","maxLength":77,"minLength":5},"description":{"description":"A brief description of the organization. ","type":"string","example":"Privacy, Security and Third-Party Risk Software","maxLength":250}},"required":["defaultApprover","externalId","name"]},"Platform-AccessManagement_PublicOrgUserCreateRequest":{"type":"object","properties":{"firstName":{"description":"The first name of the user.","type":"string","example":"Michael","maxLength":100,"minLength":0},"lastName":{"description":"The last name of the user.","type":"string","example":"Douglas","maxLength":100,"minLength":0},"email":{"description":"The email address of the user.","type":"string","format":"email","example":"abc@abc.com","maxLength":100,"minLength":0},"internal":{"description":"Indicates whether the user is an internal user.","type":"boolean","example":true,"default":"false"},"expirationDateTime":{"description":"The expiration date for the user in the system.","type":"string","format":"date-time","example":"2029-05-01T12:34:56Z"},"externalId":{"description":"The external identifier for the user.","type":"string","example":"1A2234-abc","maxLength":128,"minLength":0},"accessLevels":{"type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelCreateRequest"},"minItems":1,"uniqueItems":true},"suppressNotification":{"description":"The indicator to suppress notifying the user on creation.","type":"boolean","example":true,"default":"false"}},"required":["email","firstName","lastName"]},"Platform-AccessManagement_PublicAccessLevelRequest":{"type":"object","properties":{"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"323e4567-e89b-12d3-a456-426614174000"},"roleId":{"description":"The unique identifier of the role.","type":"string","format":"uuid","example":"223e4567-e89b-12d3-a456-426614174000"}},"required":["organizationId","roleId"]},"Platform-AccessManagement_PublicCreateGroupRequest":{"type":"object","properties":{"name":{"description":"The name of the user group.","type":"string","example":"My User Group","maxLength":100,"minLength":1},"description":{"description":"The description of the user group.","type":"string","example":"User group used for grouping users","maxLength":300}},"required":["name"]},"Platform-AccessManagement_PublicAddMembersRequest":{"type":"object","properties":{"members":{"description":"The list of user identifiers to be added to the user group.","type":"array","items":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","minItems":1},"minItems":1,"uniqueItems":true}}},"Platform-AccessManagement_CreateGroupRequest":{"type":"object","properties":{"name":{"description":"The name of the user group.","type":"string","example":"Administrators","maxLength":100,"minLength":1},"description":{"description":"The brief description of the user group.","type":"string","example":"Group for system administrators","maxLength":300}}},"Platform-AccessManagement_AddMembersRequest":{"type":"object","properties":{"members":{"description":"The list of user identifiers to be added to the user group.","type":"array","items":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"uniqueItems":true},"groupId":{"description":"The unique identifier of the user group.","type":"string","format":"uuid","example":"a739211d-d216-4398-a1c2-f7a20412692d"}}},"Platform-AccessManagement_ClientCredentialsRequest":{"type":"object","properties":{"grant_type":{"description":"The OAuth grant type. Always use 'client_credentials'.","type":"string","default":"client_credentials","enum":["client_credentials"]},"client_id":{"description":"Your OneTrust client credential identifier.","type":"string","default":"3d8efc3b94ed49628482eb2ab5e3bc8g"},"client_secret":{"description":"Your OneTrust client credential secret key.","type":"string","default":"Ycx7HNUbHWyPBZvT4WhjYyIvnEdQL3d4"}},"required":["client_id","client_secret","grant_type"]},"Platform-AccessManagement_ClientCredentialsResponse":{"type":"object","properties":{"access_token":{"description":"The OAuth access token for API authentication.","type":"string"},"email":{"description":"The API user email in the format tenantGuid@api.onetrust.com.","type":"string","format":"email"},"expires_in":{"description":"The token lifetime in seconds.","type":"integer","format":"int32"},"guid":{"description":"A unique identifier for this token session.","type":"string","format":"uuid"},"jti":{"description":"The JWT identifier for this token.","type":"string"},"languageId":{"description":"The numeric identifier for the user's language.","type":"integer","format":"int32"},"orgGroupGuid":{"description":"The unique identifier of the organization where the credential was created.","type":"string","format":"uuid"},"orgGroupId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid"},"ot_scopes":{"description":"The API scopes granted to this credential.","type":"string"},"role":{"description":"The user role associated with this token.","type":"string"},"scope":{"description":"The OAuth scope for this token.","type":"string"},"sessionId":{"description":"The unique identifier for this API session.","type":"string","format":"uuid"},"tenantGuid":{"description":"The unique identifier of your OneTrust tenant.","type":"string"},"tenantId":{"description":"The numeric identifier of your OneTrust tenant.","type":"integer","format":"int32"},"token_type":{"description":"The type of token. Always 'bearer'.","type":"string"},"user_name":{"description":"The API username in the format tenantGuid@api.onetrust.com.","type":"string","format":"email"}}},"Platform-AccessManagement_OrganizationExternalResponse":{"type":"object","properties":{"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"externalId":{"description":"The external identifier of the organization.","type":"string","example":"ext-org-123","maxLength":100},"parentOrganizationId":{"description":"The unique identifier of the parent organization.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174999"},"parentExternalId":{"description":"The external identifier of the parent organization.","type":"string","example":"ext-org-parent-456","maxLength":100},"name":{"description":"The name of the organization.","type":"string","example":"OneTrust","maxLength":255},"defaultApprover":{"description":"The email address of the default approver for the organization.","type":"string","example":"approver@onetrust.com","maxLength":255,"minLength":5},"defaultLanguageCode":{"description":"The ISO language code for the organization's default language (for example: en, fr, de, es, zh).","type":"string","example":"en","maxLength":5,"minLength":2},"description":{"description":"A brief description of the organization. ","type":"string","example":"Privacy, Security and Third-Party Risk Software","maxLength":250}}},"Platform-AccessManagement_PublicAccessLevelResponse":{"type":"object","properties":{"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"423e4567-e89b-12d3-a456-426614174000"},"organizationName":{"description":"The name of the organization.","type":"string","example":"My Org","maxLength":100,"minLength":1},"roleId":{"description":"The unique identifier of the role.","type":"string","format":"uuid","example":"423e4567-e89b-12d3-a456-426614174001"},"roleName":{"description":"The name of the role.","type":"string","example":"Audit Manager","maxLength":256,"minLength":1}}},"Platform-AccessManagement_PublicOrgUserDetailsResponse":{"type":"object","properties":{"userId":{"description":"The unique identifier of the user.","type":"string","format":"uuid","example":"423e4567-e89b-12d3-a456-426614174000"},"firstName":{"description":"The first name of the user, as it appears in their profile.","type":"string","example":"Ross","maxLength":100},"lastName":{"description":"The last name of the user, as it appears in their profile.","type":"string","example":"Taylor","maxLength":100},"fullName":{"description":"The full name of the user, combining their first and last names.","type":"string","example":"Ross Taylor","maxLength":256},"email":{"description":"The email address associated with the user's account.","type":"string","format":"email","example":"jane.doe@example.com","maxLength":255,"minLength":5},"accessLevels":{"description":"The access levels assigned to the user.","type":"array","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicAccessLevelResponse"},"uniqueItems":true},"emailConfirmed":{"description":"The indicator of whether the user's email address has been confirmed.","type":"boolean","example":true},"active":{"description":"The indicator of whether the user account is currently active.","type":"boolean","example":true},"internal":{"description":"The indicator of whether the user is an internal user, meaning they are part of the organization.","type":"boolean","example":false},"externalId":{"description":"The external identifier for the user, which may be used to reference them in external systems.","type":"string","example":"ext-123456","maxLength":128},"expirationDateTime":{"description":"The date and time the user account will expire.","type":"string","format":"date-time","example":"2025-01-01T12:00:00Z"},"disabledDateTime":{"description":"The date and time the user account was disabled.","type":"string","format":"date-time","example":"2024-06-15T08:30:00Z"},"createdDate":{"description":"The date and time the user account was created.","type":"string","format":"date-time","example":"2023-10-01T09:15:00Z"},"lastModifiedDate":{"description":"The date and time the user account was last modified.","type":"string","format":"date-time","example":"2024-02-20T14:45:00Z"},"lastLoginDate":{"description":"The date and time the user last logged in.","type":"string","format":"date-time","example":"2024-09-10T07:05:00Z"},"disabledBy":{"description":"The name of the user who disabled the current user.","type":"string","example":"Michael Douglas","maxLength":256},"defaultOrganizationName":{"description":"The name of the default organization for the user.","type":"string","example":"My Org","maxLength":100},"defaultOrganizationId":{"description":"The unique identifier of the user's default organization.","type":"string","format":"uuid","example":"423e4567-e89b-12d3-a456-426614174111"}}},"Platform-AccessManagement_PagePublicOrgUserDetailsResponse":{"type":"object","properties":{"content":{"description":"The list of users on the current page.","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicOrgUserDetailsResponse"},"type":"array"},"empty":{"description":"The flag to check if the result list is empty.","type":"boolean"},"first":{"description":"The flag to check if this is the first page.","type":"boolean"},"last":{"description":"The flag to check if this is the last page.","type":"boolean"},"number":{"description":"The current page number (0-based).","type":"integer","format":"int32"},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":1},"size":{"description":"The page size.","type":"integer","format":"int32","example":20},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int64","example":1},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"Pagination information with page number (0-based, min: 0) and page size (min: 1)","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_SortObject":{"type":"object","properties":{"empty":{"description":"Indicates whether the result set is empty, meaning no records were found.","type":"boolean"},"sorted":{"description":"Indicates whether the results are sorted in a specific order, such as ascending or descending.","type":"boolean"},"unsorted":{"description":"The indicator of whether the results are unsorted.","type":"boolean"}}},"Platform-AccessManagement_PagePublicUserGroupResponse":{"type":"object","properties":{"content":{"description":"The list of user groups on the current page.","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicUserGroupResponse"},"type":"array"},"empty":{"description":"The flag to check if the result list is empty.","type":"boolean"},"first":{"description":"The flag to check if this is the first page.","type":"boolean"},"last":{"description":"The flag to check if this is the last page.","type":"boolean"},"number":{"description":"The current page number (0-based).","type":"integer","format":"int32"},"numberOfElements":{"description":"The number of elements on the current page.","type":"integer","format":"int32","example":1},"size":{"description":"The page size.","type":"integer","format":"int32","example":20},"totalElements":{"description":"The total number of elements across all pages.","type":"integer","format":"int64","example":1},"totalPages":{"description":"The total number of pages.","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"The pagination information with page number (0-based, min: 0) and page size (min: 1).","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_PublicMemberResponse":{"type":"object","properties":{"fullName":{"description":"The full name of the member.","type":"string","example":"John Doe","maxLength":201},"email":{"description":"The email address of the member.","type":"string","format":"email","example":"jdoe@onetrust.com","maxLength":255,"minLength":5},"memberId":{"description":"The unique identifier of the member.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"enabled":{"description":"The indicator of whether the member is enabled.","type":"boolean","example":true},"internal":{"description":"The indicator of whether the member is an internal user.","type":"boolean","example":false},"createdBy":{"description":"The unique identifier of the user who added the member to the group.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"createdDate":{"description":"The timestamp of when the member was added to the group.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"}}},"Platform-AccessManagement_PagePublicMemberResponse":{"type":"object","properties":{"content":{"description":"Members of a user groups in the current page","items":{"$ref":"#/components/schemas/Platform-AccessManagement_PublicMemberResponse"},"type":"array"},"empty":{"description":"Flag to check if the result list is empty or not","type":"boolean"},"first":{"description":"Flag to check if this is the first page","type":"boolean"},"last":{"description":"Flag to check if this is the last page","type":"boolean"},"number":{"description":"Current page number (0-based)","type":"integer","format":"int32"},"numberOfElements":{"description":"Number of elements in the current page","type":"integer","format":"int32","example":1},"size":{"description":"Page size","type":"integer","format":"int32","example":20},"totalElements":{"description":"Total number of elements across all pages","type":"integer","format":"int64","example":1},"totalPages":{"description":"Total number of pages","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"Pagination information with page number (0-based, min: 0) and page size (min: 1)","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_PageUserGroupResponse":{"type":"object","properties":{"content":{"description":"The list of user groups in the current page.","items":{"$ref":"#/components/schemas/Platform-AccessManagement_UserGroupResponse"},"type":"array"},"empty":{"description":"Indicates whether the result set is empty.","type":"boolean"},"first":{"description":"Indicates whether this is the first page.","type":"boolean"},"last":{"description":"Indicates whether this is the last page.","type":"boolean"},"number":{"description":"The current page number.","type":"integer","format":"int32"},"numberOfElements":{"description":"The number of records in the current page.","type":"integer","format":"int32","example":1},"size":{"description":"The total number of records across all pages.","type":"integer","format":"int32","example":20},"totalElements":{"description":"The total number of pages available.","type":"integer","format":"int64","example":1},"totalPages":{"description":"The pagination details for this response.","type":"integer","format":"int32","example":1},"sort":{"description":"Sort order for the results.","$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"The pagination details for this response.","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_MemberResponse":{"type":"object","properties":{"fullName":{"description":"The user's full name.","type":"string","example":"John Doe","maxLength":201},"email":{"description":"The user's email address.","type":"string","format":"email","example":"jdoe@onetrust.com","maxLength":255,"minLength":5},"memberId":{"description":"The unique identifier of the group member.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"enabled":{"description":"Indicates whether the user account is active.","type":"boolean","example":true},"internal":{"description":"Indicates whether this is an internal system record.","type":"boolean","example":false},"createdBy":{"description":"The unique identifier of the user who created this record.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"},"createdDate":{"description":"The date and time when the record was created.","type":"string","format":"date-time","example":"2022-05-01T12:34:56Z"}}},"Platform-AccessManagement_PageMemberResponse":{"type":"object","properties":{"content":{"description":"The list of group members in the current page.","items":{"$ref":"#/components/schemas/Platform-AccessManagement_MemberResponse"},"type":"array"},"empty":{"description":"Indicates whether the result set is empty.","type":"boolean"},"first":{"description":"Indicates whether this is the first page.","type":"boolean"},"last":{"description":"Indicates whether this is the last page.","type":"boolean"},"number":{"description":"The current page number.","type":"integer","format":"int32"},"numberOfElements":{"description":"The number of records in the current page.","type":"integer","format":"int32","example":1},"size":{"description":"The total number of records across all pages.","type":"integer","format":"int32","example":20},"totalElements":{"description":"The total number of pages available.","type":"integer","format":"int64","example":1},"totalPages":{"description":"The pagination details for this response.","type":"integer","format":"int32","example":1},"sort":{"description":"Sort order for the results.","$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"The pagination details for this response.","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_LoginHistoryResponse":{"type":"object","properties":{"userName":{"description":"The username or email address used to log in.","type":"string","example":"johndoe@onetrust.com","maxLength":255,"minLength":5},"ipAddress":{"description":"The IP address from which the login attempt was made. Supports both IPv4 and IPv6 addresses.","type":"string","example":"127.0.0.1.","maxLength":45,"minLength":7},"userAgentString":{"description":"The browser and operating system information from the login attempt.","type":"string","example":"Chrome 90.0.4430.212 | Windows 10","maxLength":500},"createDT":{"description":"The date and time of the login attempt.","type":"string","format":"date-time","example":"2023-01-15T14:30:00Z"},"status":{"description":"The result of the login attempt (Success or Failure).","type":"string","example":"Success","enum":["Success","Failure"],"maxLength":8,"minLength":7},"userId":{"description":"The unique identifier of the user.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174001"}}},"Platform-AccessManagement_PageLoginHistoryResponse":{"type":"object","properties":{"content":{"description":"The list of login history records in the current page.","items":{"$ref":"#/components/schemas/Platform-AccessManagement_LoginHistoryResponse"},"type":"array"},"empty":{"description":"Indicates whether the result set is empty.","type":"boolean"},"first":{"description":"Indicates whether this is the first page.","type":"boolean"},"last":{"description":"Indicates whether this is the last page.","type":"boolean"},"number":{"description":"The current page number.","type":"integer","format":"int32"},"numberOfElements":{"description":"The number of records in the current page.","type":"integer","format":"int32","example":1},"size":{"description":"The total number of records across all pages.","type":"integer","format":"int32","example":20},"totalElements":{"description":"The total number of pages available.","type":"integer","format":"int64","example":1},"totalPages":{"description":"The pagination details for this response.","type":"integer","format":"int32","example":1},"sort":{"description":"Sort order for the results.","$ref":"#/components/schemas/Platform-AccessManagement_SortObject"},"pageable":{"description":"The pagination details for this response.","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"Platform-AccessManagement_OrganizationExternalBasicDetailResponse":{"type":"object","properties":{"organizationId":{"description":"The unique identifier of the organization.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174000"},"externalId":{"description":"The external identifier of the organization.","type":"string","example":"ext-org-123","maxLength":100},"parentOrganizationId":{"description":"The unique identifier of the parent organization.","type":"string","format":"uuid","example":"123e4567-e89b-12d3-a456-426614174999"},"parentExternalId":{"description":"The external identifier of the parent organization.","type":"string","example":"ext-org-parent-456","maxLength":100},"name":{"description":"The name of the organization.","type":"string","example":"OneTrust","maxLength":255},"defaultApprover":{"description":"The email address of the default approver for the organization.","type":"string","example":"approver@onetrust.com","maxLength":255,"minLength":5},"defaultLanguageCode":{"description":"The ISO language code for the organization's default language (for example: en, fr, de, es, zh).","type":"string","example":"en","maxLength":5,"minLength":2},"description":{"description":"A brief description of the organization. ","type":"string","example":"Privacy, Security and Third-Party Risk Software","maxLength":250},"children":{"description":"The list of child organizations in the hierarchy.","type":"array","items":{"type":"object","example":{"children":[],"defaultApprover":"user2@onetrust.com","defaultLanguageCode":"en","description":"Global Privacy Compliance","externalId":"ext-org-123","name":"DataGuidance","parentExternalId":"ext-org-parent-456"}}}},"title":"OrganizationExternalBasicDetailResponse"},"Platform-AccessManagement_PublicDeleteMembersRequest":{"type":"object","properties":{"members":{"description":"The list of user identifiers to be removed from the user group.","type":"array","items":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000","minItems":1},"minItems":1,"uniqueItems":true}}},"Platform-AccessManagement_DeleteMembersRequest":{"type":"object","properties":{"members":{"description":"The list of user identifiers of the user group. ","type":"array","items":{"type":"string","format":"uuid","example":"550e8400-e29b-41d4-a716-446655440000"},"uniqueItems":true},"groupId":{"description":"The unique identifier of the user group.","type":"string","format":"uuid","example":"a739211d-d216-4398-a1c2-f7a20412692d"}}},"AuditRecords_UserActivityResponse":{"type":"object","properties":{"name":{"description":"Name of the user","type":"string","example":"Test User6"},"email":{"description":"Email address","type":"string","example":"tu7@rootorg.com"},"event":{"description":"Event type","type":"string","example":"User Edit"},"fieldName":{"description":"Field Name","type":"string","example":"Email Address"},"oldValue":{"description":"Old value","type":"string","example":"tu6@rootorg.com"},"newValue":{"description":"New value","type":"string","example":"tu7@rootorg.com"},"method":{"description":"Method name","type":"string","example":"User Provisioning"},"updatedBy":{"description":"Updated by","type":"string","example":"OneTrust User"},"date":{"description":"Date of the event","type":"string","format":"date-time","example":"2024-09-13T23:02:21.659738Z"}}},"AuditRecords_PageUserActivityResponse":{"type":"object","properties":{"content":{"description":"List of User Activities in the current page","items":{"$ref":"#/components/schemas/AuditRecords_UserActivityResponse"},"type":"array"},"empty":{"description":"Flag to check if the result list is empty or not","type":"boolean"},"first":{"description":"Flag to check if this is the first page","type":"boolean"},"last":{"description":"Flag to check if this is the last page","type":"boolean"},"number":{"description":"Current page number (0-based)","type":"integer","format":"int32"},"numberOfElements":{"description":"Number of elements in the current page","type":"integer","format":"int32","example":1},"size":{"description":"Page size","type":"integer","format":"int32","example":20},"totalElements":{"description":"Total number of elements across all pages","type":"integer","format":"int64","example":1},"totalPages":{"description":"Total number of pages","type":"integer","format":"int32","example":1},"sort":{"$ref":"#/components/schemas/AuditRecords_SortObject"},"pageable":{"description":"Pagination information with page number (0-based, min: 0) and page size (min: 1)","type":"object","example":{"offset":0,"pageNumber":0,"pageSize":20,"paged":true,"sort":[{"ascending":true,"descending":false,"direction":"ASC","ignoreCase":false,"nullHandling":"NATIVE","property":"name"}],"unpaged":false}}}},"AuditRecords_SortObject":{"type":"object","properties":{"empty":{"type":"boolean"},"sorted":{"type":"boolean"},"unsorted":{"type":"boolean"}}}},"securitySchemes":{"Platform-AccessManagement_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"ORGANIZATION":"Grants full access to manage organizations. This includes Create, Read, Update and Delete operations.","USER":"Grants full access to manage Users, User Groups and User Group membership. This includes Create, Read, Update and Delete operations."}}}},"AuditRecords_OAUTH2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://{hostname}/api/access/v1/oauth/token","scopes":{"USER":"Grants full access to manage Users, User Groups and User Group membership. This includes Create, Read, Update and Delete operations."}}}}}}}