openapi: 3.2.0
info:
  title: Platform - Access Management User Groups V2 API
  version: '1.0'
  contact:
    name: OneTrust Support
    url: https://my.onetrust.com/s/contactsupport
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  description: The Access Management APIs enable you to programmatically control user access, manage organizational hierarchies, and monitor authentication activities across your OneTrust platform.
servers:
- url: https://{hostname}
  variables:
    hostname:
      default: hostname
      description: The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com.
tags:
- name: User Groups V2
  description: APIs to manage user groups and their memberships. Create groups to organize users, assign permissions collectively, add or remove members, and retrieve information about existing groups and their members.
  externalDocs:
    description: OpenAPI 3.1.0 - Download Definition
    url: https://developer.onetrust.com/onetrust/openapi/platform-access-management.json
  x-displayName: User Groups V2
paths:
  /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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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
components:
  schemas:
    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_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_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_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_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_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_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_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_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_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_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_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'
  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.
x-readme:
  explorer-enabled: false
  proxy-enabled: false
  metrics-enabled: false
x-onetrust:
  spec-label: OpenAPI 3.1.0