Genesys

Genesys Users API

Me, routing, roles

GitHub OpenAPI

Operations 121

GET /api/v2/authorization/divisionspermitted/me Returns which divisions the current user has the given permission in. #
GET /api/v2/authorization/divisionspermitted/paged/me Returns which divisions the current user has the given permission in. #
GET /api/v2/authorization/divisionspermitted/paged/{subjectId} Returns which divisions the specified user has the given permission in. #
GET /api/v2/users/{userId}/verifiers Get a list of verifiers #
PUT /api/v2/users/{userId}/verifiers/{verifierId} Update a verifier #
DELETE /api/v2/users/{userId}/verifiers/{verifierId} Delete a verifier #
POST /api/v2/analytics/users/aggregates/query Query for user aggregates #
POST /api/v2/analytics/users/aggregates/jobs Query for user aggregates asynchronously #
GET /api/v2/analytics/users/aggregates/jobs/{jobId} Get status for async query for user aggregates #
DELETE /api/v2/analytics/users/aggregates/jobs/{jobId} Delete/cancel an async request for user aggregates #
GET /api/v2/analytics/users/aggregates/jobs/{jobId}/results Fetch a page of results for an async aggregates query #
POST /api/v2/analytics/users/details/query Query for user details #
POST /api/v2/analytics/users/observations/query Query for user observations #
POST /api/v2/analytics/users/activity/query Query for user activity observations #
POST /api/v2/analytics/users/details/jobs Query for user details asynchronously #
GET /api/v2/analytics/users/details/jobs/{jobId} Get status for async query for user details #
DELETE /api/v2/analytics/users/details/jobs/{jobId} Delete/cancel an async request #
GET /api/v2/analytics/users/details/jobs/{jobId}/results Fetch a page of results for an async query #
GET /api/v2/analytics/users/details/jobs/availability Lookup the datalake availability date and time #
GET /api/v2/authorization/subjects/me Returns a listing of roles and permissions for the currently authenticated user. #
GET /api/v2/authorization/subjects/{subjectId} Returns a listing of roles and permissions for a user. #
POST /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Make a grant of a role in a division #
DELETE /api/v2/authorization/subjects/{subjectId}/divisions/{divisionId}/roles/{roleId} Delete a grant of a role in a division #
POST /api/v2/authorization/subjects/{subjectId}/bulkadd Bulk-grant roles and divisions to a subject. #
POST /api/v2/authorization/subjects/{subjectId}/bulkreplace Replace subject's roles and divisions with the exact list supplied in the request. #
POST /api/v2/authorization/subjects/{subjectId}/bulkremove Bulk-remove grants from a subject. #
GET /api/v2/users/{subjectId}/roles Returns a listing of roles and permissions for a user. #
PUT /api/v2/users/{subjectId}/roles Sets the user's roles #
GET /api/v2/users/{userId}/callforwarding Get a user's CallForwarding #
PUT /api/v2/users/{userId}/callforwarding Update a user's CallForwarding #
PATCH /api/v2/users/{userId}/callforwarding Patch a user's CallForwarding #
GET /api/v2/fieldconfig Fetch field config for an entity type #
GET /api/v2/users/{userId}/favorites Deprecated; will be revived with new contract #
GET /api/v2/users/{userId}/adjacents Get adjacents #
GET /api/v2/users/{userId}/superiors Get superiors #
GET /api/v2/users/{userId}/directreports Get direct reports #
GET /api/v2/users/{userId}/profile Get user profile #
GET /api/v2/profiles/users Get a user profile listing #
GET /api/v2/users/{userId}/geolocations/{clientId} Get a user's Geolocation #
PATCH /api/v2/users/{userId}/geolocations/{clientId} Patch a user's Geolocation #
GET /api/v2/users/{userId}/outofoffice Get a OutOfOffice #
PUT /api/v2/users/{userId}/outofoffice Update an OutOfOffice #
GET /api/v2/routing/directroutingbackup/settings/me Get the user's Direct Routing Backup settings. #
PUT /api/v2/routing/directroutingbackup/settings/me Update the user's Direct Routing Backup settings. #
DELETE /api/v2/routing/directroutingbackup/settings/me Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. #
GET /api/v2/routing/users/{userId}/directroutingbackup/settings Get the user's Direct Routing Backup settings. #
PUT /api/v2/routing/users/{userId}/directroutingbackup/settings Update the user's Direct Routing Backup settings. #
DELETE /api/v2/routing/users/{userId}/directroutingbackup/settings Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default. #
GET /api/v2/routing/users/{userId}/utilization Get the user's max utilization settings. If not configured, the organization-wide default is returned. #
PUT /api/v2/routing/users/{userId}/utilization Update the user's max utilization settings. Include only those media types requiring custom configuration. Any omitted media types will be set to the organization's default values. #
DELETE /api/v2/routing/users/{userId}/utilization Delete the user's max utilization settings and revert to the organization-wide default. #
GET /api/v2/users/chats/me Get chats for a user #
GET /api/v2/users/externalid/{authorityName}/{externalKey} Get the user associated with external identifier. #
GET /api/v2/users/{userId}/externalid/{authorityName} Get the external identifier of user for an authority. #
GET /api/v2/users/{userId}/externalid Get the external identifiers for a user. #
POST /api/v2/users/{userId}/externalid Create mapping between external identifier and user. Limit 100 per entity. #
DELETE /api/v2/users/{userId}/externalid/{authorityName}/{externalKey} Delete the external identifier for user. #
POST /api/v2/users/me/password Change your password #
GET /api/v2/users/me Get current user details. #
POST /api/v2/users/{userId}/password Change a users password #
GET /api/v2/users/{userId}/profileskills List profile skills for a user #
PUT /api/v2/users/{userId}/profileskills Update profile skills for a user #
PATCH /api/v2/users/{userId}/queues/{queueId} Join or unjoin a queue for a user #
GET /api/v2/users/{userId}/queues Get queues for user #
PATCH /api/v2/users/{userId}/queues Join or unjoin a set of queues for a user #
GET /api/v2/users/{userId} Get user. #
DELETE /api/v2/users/{userId} Delete user #
PATCH /api/v2/users/{userId} Update user #
POST /api/v2/users/{userId}/invite Send an activation email to the user #
DELETE /api/v2/users/{userId}/routinglanguages/{languageId} Remove a routing language from a user #
PATCH /api/v2/users/{userId}/routinglanguages/{languageId} Update an assigned routing language's proficiency #
GET /api/v2/users/{userId}/routinglanguages List routing languages assigned to a user #
POST /api/v2/users/{userId}/routinglanguages Assign a routing language to a user #
PATCH /api/v2/users/{userId}/routinglanguages/bulk Assign multiple routing languages to a user. Max 50 routing languages in request body #
PUT /api/v2/users/{userId}/routingskills/{skillId} Update an assigned routing skill's proficiency #
DELETE /api/v2/users/{userId}/routingskills/{skillId} Remove a routing skill from a user #
GET /api/v2/users/{userId}/routingskills List routing skills assigned to a user #
POST /api/v2/users/{userId}/routingskills Assign a routing skill to a user #
PUT /api/v2/users/{userId}/routingskills/bulk Assign multiple routing skills to a user, replacing any current assignments #
PATCH /api/v2/users/{userId}/routingskills/bulk Assign multiple routing skills to a user #
GET /api/v2/users/{userId}/routingstatus Fetch the routing status of a user #
PUT /api/v2/users/{userId}/routingstatus Update the routing status of a user #
GET /api/v2/users/stations/me Get station information for self #
DELETE /api/v2/users/stations/me/associatedstation Clear self associated station #
PUT /api/v2/users/stations/me/associatedstation/{stationId} Set self associated station #
GET /api/v2/users/{userId}/skillgroups Get skill groups for a user #
GET /api/v2/users/{userId}/state Get user state information. #
PUT /api/v2/users/{userId}/state Update user state information. #
GET /api/v2/users/{userId}/station Get station information for user #
DELETE /api/v2/users/{userId}/station/associatedstation Clear associated station #
PUT /api/v2/users/{userId}/station/associatedstation/{stationId} Set associated station #
PUT /api/v2/users/{userId}/station/defaultstation/{stationId} Set default station #
DELETE /api/v2/users/{userId}/station/defaultstation Clear default station #
GET /api/v2/users/{userId}/trustors List the organizations that have authorized/trusted the user. #
PATCH /api/v2/users/bulk Update bulk acd autoanswer on users. Max 50 users can be updated at a time. #
GET /api/v2/users/query Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required #
GET /api/v2/users Get the list of available users. #
POST /api/v2/users Create user #
GET /api/v2/users/search Search users using the q64 value returned from a previous search #
POST /api/v2/users/search Search users #
POST /api/v2/users/search/teams/assign Search users assigned to teams #
GET /api/v2/users/customattributes/schemas/coretypes/{coreTypeName} Get the core types from which all schemas are built. #
GET /api/v2/users/customattributes/schemas/coretypes Get the list of core types enabled for a specific namespace. #
PUT /api/v2/users/{userId}/customattributes Create or update a single custom attributes record. Updating replaces all data with the provided fields. #
PATCH /api/v2/users/{userId}/customattributes Update a single custom attributes record by amending the data with only the provided fields. #
GET /api/v2/users/{userId}/customattributes/{schemaId} Get custom attributes by schema id #
DELETE /api/v2/users/{userId}/customattributes/{schemaId} Delete a custom attributes record. #
GET /api/v2/users/{userId}/customattributes/bulk Get multiple custom attributes records by schema ids #
PATCH /api/v2/users/{userId}/customattributes/bulk Update multiple custom attributes records by amending the data with only the provided fields. #
GET /api/v2/users/customattributes/schemas/limits Get quantitative limits on schemas #
GET /api/v2/users/customattributes/schemas/{schemaId} Get a schema #
PUT /api/v2/users/customattributes/schemas/{schemaId} Update a schema #
DELETE /api/v2/users/customattributes/schemas/{schemaId} Delete a schema #
GET /api/v2/users/customattributes/schemas/{schemaId}/versions Get all versions of a user schema #
GET /api/v2/users/customattributes/schemas/{schemaId}/versions/{versionId} Get a specific version of a schema #
GET /api/v2/users/customattributes/schemas Get a list of schemas. #
POST /api/v2/users/customattributes/schemas Create a schema #
GET /api/v2/users/development/activities Get list of Development Activities #
GET /api/v2/users/development/activities/me Get list of Development Activities for current user #
GET /api/v2/users/development/activities/{activityId} Get a Development Activity #
POST /api/v2/users/development/activities/aggregates/query Retrieve aggregated development activity data #

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/authentication/genesys-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-users-api-openapi.yml

Other Resources

🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/scopes/genesys-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/conventions/genesys-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/errors/genesys-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/data-model/genesys-data-model.yml
🔗
AgenticAccess
https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/agentic-access/genesys-agentic-access.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/genesys-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

genesys-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
  version: v2
  title: PureCloud Platform Agent Assistants Users API
  termsOfService: https://help.genesys.cloud/articles/terms-and-conditions/
  contact:
    name: PureCloud Developer Evangelists
    url: https://developer.genesys.cloud/
    email: DeveloperEvangelists@genesys.com
  license:
    name: UNLICENSED
    url: https://help.genesys.cloud/articles/terms-and-conditions/
servers:
- url: https://api.mypurecloud.com
tags:
- name: Users
  description: Me, routing, roles
  externalDocs:
    description: Users Documentation
    url: https://developer.genesys.cloud/useragentman/users/
paths:
  /api/v2/authorization/divisionspermitted/me:
    get:
      tags:
      - Users
      summary: Returns which divisions the current user has the given permission in.
      description: This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      operationId: getAuthorizationDivisionspermittedMe
      parameters:
      - name: name
        in: query
        description: Search term to filter by division name
        required: false
        schema:
          type: string
      - name: permission
        in: query
        description: The permission string, including the object to access, e.g. routing:queue:view
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AuthzDivision'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            missing.permission.param: Missing required permission parameter
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - authorization
        - authorization:readonly
      deprecated: true
      x-purecloud-method-name: getAuthorizationDivisionspermittedMe
  /api/v2/authorization/divisionspermitted/paged/me:
    get:
      tags:
      - Users
      summary: Returns which divisions the current user has the given permission in.
      description: ''
      operationId: getAuthorizationDivisionspermittedPagedMe
      parameters:
      - name: permission
        in: query
        description: The permission string, including the object to access, e.g. routing:queue:view
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: Page number
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DivsPermittedEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            missing.permission.param: Missing required permission parameter
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - authorization
        - authorization:readonly
      x-purecloud-method-name: getAuthorizationDivisionspermittedPagedMe
  /api/v2/authorization/divisionspermitted/paged/{subjectId}:
    get:
      tags:
      - Users
      summary: Returns which divisions the specified user has the given permission in.
      description: This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      operationId: getAuthorizationDivisionspermittedPagedSubjectId
      parameters:
      - name: subjectId
        in: path
        description: Subject ID (user or group)
        required: true
        schema:
          type: string
      - name: permission
        in: query
        description: The permission string, including the object to access, e.g. routing:queue:view
        required: true
        schema:
          type: string
      - name: pageNumber
        in: query
        description: Page number
        required: false
        schema:
          type: integer
          format: int32
          default: 1
      - name: pageSize
        in: query
        description: Page size
        required: false
        schema:
          type: integer
          format: int32
          default: 25
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DivsPermittedEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            missing.permission.param: Missing required permission parameter
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - authorization
        - authorization:readonly
      deprecated: true
      x-purecloud-method-name: getAuthorizationDivisionspermittedPagedSubjectId
  /api/v2/users/{userId}/verifiers:
    get:
      tags:
      - Users
      summary: Get a list of verifiers
      description: ''
      operationId: getUserVerifiers
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifierEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '401':
          description: No authentication bearer token specified in authorization header.
          x-inin-error-codes:
            authentication.required: No authentication bearer token specified in authorization header.
            ip.not.authorized: 'Requests originating from this IP address are not authorized: [%s]'
            bad.credentials: Invalid login credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: You are not authorized to perform the requested action.
          x-inin-error-codes:
            missing.division.permission: Unable to perform the requested action. You are missing the following permission '%s' in the provided division(s).
            app.not.authorized.for.scope: App not authorized to use scope %s
            missing.permissions: 'Unable to perform the requested action. You are missing the following permission(s): %s'
            not.authorized: You are not authorized to perform the requested action.
            missing.any.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s'
            authz.policy.denied: 'Unable to perform the requested action. Your organization''s security policies have denied access. Policy ID(s): [%s]'
            missing.any.division.permissions: 'Unable to perform the requested action. You must have at least one of the following permissions assigned: %s in at least one of the following division(s): %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: The requested resource was not found.
          x-inin-error-codes:
            not.found: The requested resource was not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '408':
          description: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          x-inin-error-codes:
            client.timeout: The client did not produce a request within the server timeout limit. This can be caused by a slow network connection and/or large payloads.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '409':
          description: The request conflicts with the current state of the target resource.
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          x-inin-error-codes:
            unsupported.media.type: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          x-inin-error-codes:
            too.many.requests.retry.after: Rate limit exceeded the maximum. Retry the request in [%s] seconds
            too.many.requests: Rate limit exceeded the maximum [%s] requests within [%s] seconds
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '504':
          description: The request timed out.
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
      security:
      - PureCloud OAuth:
        - users
        - users:readonly
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - mfa:verifier:view
      x-purecloud-method-name: getUserVerifiers
  /api/v2/users/{userId}/verifiers/{verifierId}:
    put:
      tags:
      - Users
      summary: Update a verifier
      description: ''
      operationId: putUserVerifier
      parameters:
      - name: userId
        in: path
        description: User ID
        required: true
        schema:
          type: string
      - name: verifierId
        in: path
        description: Verifier ID
        required: true
        schema:
          type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Verifier'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          x-inin-error-codes:
            bad.request: The request could not be understood by the server due to malformed syntax.
            response.entity.too.large: The response is over the size limit. Reduce pageSize or expand list to reduce response size if applicable
            invalid.date: 'Dates must be specified as ISO-8601 strings. For example: yyyy-MM-ddTHH:mm:ss.SSSZ'
            invalid.query.param.value: 'Value [%s] is not valid for parameter [%s]. Allowable values are: %s'
            client.failed.request: The client did not produce a request with valid end of stream signaling. This can be caused by poor network connection and/or client behavior.
            invalid.property: Value [%s] is not a valid property for object [%s]
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'


# --- truncated at 32 KB (1131 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/genesys/refs/heads/main/openapi/genesys-users-api-openapi.yml