swagger: '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 Groups 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/
host: api.mypurecloud.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
tags:
- name: Groups
  description: Groups, members
  externalDocs:
    description: Groups Documentation
    url: https://developer.genesys.cloud/useragentman/groups/
paths:
  /api/v2/fieldconfig:
    get:
      tags:
      - Groups
      summary: Fetch field config for an entity type
      description: ''
      operationId: getFieldconfig
      produces:
      - application/json
      parameters:
      - name: type
        in: query
        description: Field type
        required: true
        type: string
        enum:
        - person
        - group
        - org
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/FieldConfig'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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]
            bad.entity.type: The entity type is invalid.
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - users
        - users:readonly
      deprecated: true
      x-purecloud-method-name: getFieldconfig
  /api/v2/groups/{groupId}/individuals:
    get:
      tags:
      - Groups
      summary: Get all individuals associated with the group
      description: ''
      operationId: getGroupIndividuals
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      x-purecloud-method-name: getGroupIndividuals
  /api/v2/groups/{groupId}/members:
    get:
      tags:
      - Groups
      summary: Get group members, includes individuals, owners, and dynamically included people
      description: ''
      operationId: getGroupMembers
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: sortOrder
        in: query
        description: Ascending or descending sort order
        required: false
        type: string
        default: ASC
        enum:
        - ascending
        - descending
      - name: expand
        in: query
        description: Which fields, if any, to expand
        required: false
        type: array
        items:
          type: string
          enum:
          - routingStatus
          - presence
          - integrationPresence
          - conversationSummary
          - outOfOffice
          - geolocation
          - station
          - authorization
          - lasttokenissued
          - authorization.unusedRoles
          - team
          - workPlanBidRanks
          - externalContactsSettings
          - groups
          - customAttributes
          - profileSkills
          - certifications
          - locations
          - skills
          - languages
          - languagePreference
          - employerInfo
          - biography
          - dateLastLogin
          - dateWelcomeSent
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/UserEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            general.resource.not.found: The resource could not be found.
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      x-purecloud-method-name: getGroupMembers
    post:
      tags:
      - Groups
      summary: Add members
      description: ''
      operationId: postGroupMembers
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      - in: body
        name: body
        description: Add members
        required: true
        schema:
          $ref: '#/definitions/GroupMembersUpdate'
      responses:
        '202':
          description: Success, group membership was updated
          schema:
            $ref: '#/definitions/Empty'
        '409':
          description: Resource conflict - Unexpected version was provided
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
            general.conflict: The version supplied does not match the current version of the user
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
            general.resource.not.found: Group members were not found.
            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'
            general.conflict: Resource conflict updating members.
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-purecloud-method-name: postGroupMembers
    delete:
      tags:
      - Groups
      summary: Remove members
      description: ''
      operationId: deleteGroupMembers
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      - name: ids
        in: query
        description: Comma separated list of userIds to remove. A maximum of 50 members are allowed per request.
        required: true
        type: string
      responses:
        '202':
          description: Success, group membership was updated
          schema:
            $ref: '#/definitions/Empty'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-purecloud-method-name: deleteGroupMembers
  /api/v2/groups/{groupId}/profile:
    get:
      tags:
      - Groups
      summary: Get group profile
      description: This api is deprecated. Use /api/v2/groups instead
      operationId: getGroupProfile
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: groupId
        required: true
        type: string
      - name: fields
        in: query
        description: Comma separated fields to return.  Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
        required: false
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GroupProfile'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            general.resource.not.found: Unable to find the group profile
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      deprecated: true
      x-purecloud-method-name: getGroupProfile
  /api/v2/profiles/groups:
    get:
      tags:
      - Groups
      summary: Get group profile listing
      description: This api is deprecated. Use /api/v2/groups instead.
      operationId: getProfilesGroups
      produces:
      - application/json
      parameters:
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: id
        in: query
        description: id
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: jabberId
        in: query
        description: A list of jabberIds to fetch by bulk (cannot be used with the "id" parameter)
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: sortOrder
        in: query
        description: Ascending or descending sort order
        required: false
        type: string
        default: ASC
        enum:
        - ascending
        - descending
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GroupProfileEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      deprecated: true
      x-purecloud-method-name: getProfilesGroups
  /api/v2/groups/{groupId}:
    get:
      tags:
      - Groups
      summary: Get group
      description: ''
      operationId: getGroup
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Group'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            general.resource.not.found: Unable to find a group with that groupId
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      x-purecloud-method-name: getGroup
    put:
      tags:
      - Groups
      summary: Update group
      description: ''
      operationId: putGroup
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      - in: body
        name: body
        description: Group
        required: false
        schema:
          $ref: '#/definitions/GroupUpdate'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Group'
        '409':
          description: Resource conflict - Unexpected version was provided
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
            general.bad.request: Unable to update group configuration due to invalid request.
            invalid.property: Value [%s] is not a valid property for object [%s]
            invalid.standalone.phone: Phone ID provided does not exist or is not standalone.
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            general.conflict: Resource conflict - Unexpected version was provided
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - directory:group:edit
      x-purecloud-method-name: putGroup
    delete:
      tags:
      - Groups
      summary: Delete group
      description: ''
      operationId: deleteGroup
      produces:
      - application/json
      parameters:
      - name: groupId
        in: path
        description: Group ID
        required: true
        type: string
      responses:
        default:
          description: successful operation
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            general.resource.not.found: Specified group not found.
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - directory:group:delete
      x-purecloud-method-name: deleteGroup
  /api/v2/groups:
    get:
      tags:
      - Groups
      summary: Get a group list
      description: ''
      operationId: getGroups
      produces:
      - application/json
      parameters:
      - name: pageSize
        in: query
        description: Page size
        required: false
        type: integer
        default: 25
        format: int32
      - name: pageNumber
        in: query
        description: Page number
        required: false
        type: integer
        default: 1
        format: int32
      - name: id
        in: query
        description: id
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: jabberId
        in: query
        description: A list of jabberIds to fetch by bulk (cannot be used with the "id" parameter)
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      - name: sortOrder
        in: query
        description: Ascending or descending sort order
        required: false
        type: string
        default: ASC
        enum:
        - ascending
        - descending
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GroupEntityListing'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      x-purecloud-method-name: getGroups
    post:
      tags:
      - Groups
      summary: Create a group
      description: ''
      operationId: postGroups
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Group
        required: true
        schema:
          $ref: '#/definitions/GroupCreate'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/Group'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          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]
            invalid.standalone.phone: Phone ID provided does not exist or is not standalone.
            group.name.in.use: This group name is currently in use.
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-inin-requires-permissions:
        type: ANY
        permissions:
        - directory:group:add
      x-purecloud-method-name: postGroups
  /api/v2/groups/search:
    get:
      tags:
      - Groups
      summary: Search groups using the q64 value returned from a previous search
      description: ''
      operationId: getGroupsSearch
      produces:
      - application/json
      parameters:
      - name: q64
        in: query
        description: q64
        required: true
        type: string
      - name: expand
        in: query
        description: expand
        required: false
        type: array
        items:
          type: string
        collectionFormat: multi
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GroupsSearchResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.search.criteria: search criteria exceeded limit
            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]
            search.criteria.values.exceed.limit: search criteria values exceeded limit
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            too.many.requested.results: too many requested results
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
        - groups:readonly
      x-purecloud-method-name: getGroupsSearch
    post:
      tags:
      - Groups
      summary: Search groups
      description: ''
      operationId: postGroupsSearch
      produces:
      - application/json
      parameters:
      - in: body
        name: body
        description: Search request options
        required: true
        schema:
          $ref: '#/definitions/GroupSearchRequest'
      responses:
        '200':
          description: successful operation
          schema:
            $ref: '#/definitions/GroupsSearchResponse'
        '400':
          description: The request could not be understood by the server due to malformed syntax.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            too.many.search.criteria: search criteria exceeded limit
            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]
            search.criteria.values.exceed.limit: search criteria values exceeded limit
            constraint.validation: '%s'
            invalid.value: 'Value [%s] is not valid for field type [%s]. Allowable values are: %s'
            too.many.requested.results: too many requested results
        '401':
          description: No authentication bearer token specified in authorization header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '403':
          description: You are not authorized to perform the requested action.
          schema:
            $ref: '#/definitions/ErrorBody'
          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'
        '404':
          description: The requested resource was not found.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            not.found: The requested resource was not found.
        '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.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '409':
          description: The request conflicts with the current state of the target resource.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.conflict: The request conflicts with the current state of the target resource.
        '413':
          description: 'The request is over the size limit. Maximum bytes: %s'
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            request.entity.too.large: 'The request is over the size limit. Maximum bytes: %s'
        '415':
          description: Unsupported Media Type - Unsupported or incorrect media type, such as an incorrect Content-Type value in the header.
          schema:
            $ref: '#/definitions/ErrorBody'
          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.
        '429':
          description: Rate limit exceeded the maximum. Retry the request in [%s] seconds
          schema:
            $ref: '#/definitions/ErrorBody'
          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
        '500':
          description: The server encountered an unexpected condition which prevented it from fulfilling the request.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            internal.server.error: The server encountered an unexpected condition which prevented it from fulfilling the request.
        '503':
          description: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            service.unavailable: Service Unavailable - The server is currently unavailable (because it is overloaded or down for maintenance).
        '504':
          description: The request timed out.
          schema:
            $ref: '#/definitions/ErrorBody'
          x-inin-error-codes:
            authentication.request.timeout: Authentication request timeout.
            request.timeout: The request timed out.
      security:
      - PureCloud OAuth:
        - groups
      x-purecloud-method-name: postGroupsSearch
definitions:
  Team:
    type: object
    required:
    - name
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The team name
      division:
        description: The division to which this entity belongs.
        $ref: '#/definitions/WritableDivision'
      description:
        type: string
        description: Team information.
      dateCreated:
        type: string
        format: date-time
        description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateModified:
        type: string
        format: date-time
        description: 'Last modified datetime. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      memberCount:
        type: integer
        format: int64
        description: Number of members in a team
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  UserConversationSummary:
    type: object
    properties:
      userId:
        type: string
      call:
        $ref: '#/definitions/MediaSummary'
      callback:
        $ref: '#/definitions/MediaSummary'
      email:
        $ref: '#/definitions/MediaSummary'
      message:
        $ref: '#/definitions/MediaSummary'
      chat:
        $ref: '#/definitions/MediaSummary'
      socialExpression:
        $ref: '#/definitions/MediaSummary'
      video:
        $ref: '#/definitions/MediaSummary'
  GroupProfileEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/GroupProfile'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  Image:
    type: object
    properties:
      resolution:
        type: string
        description: 'Height and/or width of image. ex: 640x480 or x128'
      imageUri:
        type: string
  AddressableEntityRef:
    type: object
    properties:
      id:
        type: string
      selfUri:
        type: string
        format: uri
  User:
    type: object
    required:
    - version
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      division:
        description: The division to which this entity belongs.
        $ref: '#/definitions/Division'
      chat:
        $ref: '#/definitions/Chat'
      department:
        type: string
      email:
        type: string
      primaryContactInfo:
        type: array
        description: Auto populated from addresses.
        readOnly: true
        items:
          $ref: '#/definitions/Contact'
      addresses:
        type: array
        description: Email addresses and phone numbers for this user
        items:
          $ref: '#/definitions/Contact'
      state:
        type: string
        description: The current state for this user.
        readOnly: true
        enum:
        - active
        - inactive
        - deleted
      title:
        type: string
      username:
        type: string
      manager:
        $ref: '#/definitions/User'
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      version:
        type: integer
        format: int32
        description: Required when updating a user, this value should be the current version of the user.  The current version can be obtained with a GET on the user before doing a PATCH.
      certifications:
        type: array
        items:
          type: string
      biography:
        $ref: '#/definitions/Biography'
      employerInfo:
        $ref: '#/definitions/EmployerInfo'
      preferredName:
        type: string
        description: Preferred full name of the agent
      routingStatus:
        description: ACD routing status
        readOnly: true
        $ref: '#/definitions/RoutingStatus'
      presence:
        description: Active presence
        readOnly: true
        $ref: '#/definitions/UserPresence'
      integrationPresence:
        description: Integration presence
        readOnly: true
        $ref: '#/definitions/UserPresence'
      conversationSummary:
        description: Summary of conversion statistics for conversation types.
        readOnly: true
        $ref: '#/definitions/UserConversationSummary'
      outOfOffice:
        description: Determine if out of office is enabled
        readOnly: true
        $ref: '#/definitions/OutOfOffice'
      geolocation:
        description: Current geolocation position
        readOnly: true
        $ref: '#/definitions/Geolocation'
      station:
        description: Effective, default, and last station information
        readOnly: true
        $ref: '#/definitions/UserStations'
      authorization:
        description: Roles and permissions assigned to the user
        readOnly: true
        $ref: '#/definitions/UserAuthorization'
      profileSkills:
        type: array
        description: Profile skills possessed by the user
        readOnly: true
        items:
          type: string
      locations:
        type: array
        description: The user placement at each site location.
        readOnly: true
        items:
          $ref: '#/definitions/Location'
      groups:
        type: array
        description: The groups the user is a member of
        readOnly: true
        items:
          $ref: '#/definitions/Group'
      team:
        description: The team the user is a member of
        readOnly: true
        $ref: '#/definitions/Team'
      workPlanBidRanks:
        description: The WFM work plan bid rank settings for the user
        readOnly: true
        $ref: '#/definitions/WorkPlanBidRanks'
      skills:
        type: array
        description: Routing (ACD) skills possessed by the user
        readOnly: true
        items:
          $ref: '#/definitions/UserRoutingSkill'
      languages:
        type: array
        description: Routing (ACD) languages possessed by the user
        readOnly: true
        items:
          $ref: '#/definitions/UserRoutingLanguage'
      acdAutoAnswer:
        type: boolean
        description: acd auto answer
      languagePreference:
        type: string
        description: preferred language by the user
        readOnly: true
      lastTokenIssued:
        $ref: '#/definitions/OAuthLastTokenIssued'
      dateLastLogin:
        type: string
        format: date-time
        description: 'The last time the user logged in using username and password. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      dateWelcomeSent:
        type: string
        format: date-time
        description: 'The date & time the user was sent their welcome email. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  WorkPlanBidRanks:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the user.
      workPlanBiddingPerformance:
        type: integer
        format: int32
        description: Work plan bidding agent performance ranking. The range of values is between 0 and 9999.
      biddingTieBreaker:
        type: string
        description: Custom agent ranking metric that some customers can use.
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Education:
    type: object
    properties:
      school:
        type: string
      fieldOfStudy:
        type: string
      notes:
        type: string
        description: Notes about education has a 2000 character limit
      dateStart:
        type: string
        format: date
        description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd'
      dateEnd:
        type: string
        format: date
        description: 'Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd'
  MediaSummaryDetail:
    type: object
    properties:
      active:
        type: integer
        format: int32
      acw:
        type: integer
        format: int32
  GroupMembersUpdate:
    type: object
    required:
    - memberIds
    properties:
      memberIds:
        type: array
        description: A list of the ids of the members to add. A maximum of 50 members are allowed per request.
        items:
          type: string
      version:
        type: integer
        format: int32
        description: The current group version.
  GroupSearchCriteria:
    type: object
    required:
    - type
    properties:
      endValue:
        type: string
        description: The end value of the range. This field is used for range search types.
      values:
        type: array
        description: A list of values for the search to match against
        items:
          type: string
      startValue:
        type: string
        description: The start value of the range. This field is used for range search types.
      value:
        type: string
        description: A value for the search to match against
      operator:
        type: string
        description: How to apply this search criteria against other criteria
        enum:
        - AND
        - OR
        - NOT
      group:
        type: array
        description: Groups multiple conditions
        items:
          $ref: '#/definitions/GroupSearchCriteria'
      dateFormat:
        type: string
        description: Set date format for criteria values when using date range search type.  Supports Java date format syntax, example yyyy-MM-dd'T'HH:mm:ss.SSSX.
      type:
        type: string
        description: Search Type
        enum:
        - EXACT
        - STARTS_WITH
        - CONTAINS
        - REGEX
        - TERM
        - TERMS
        - REQUIRED_FIELDS
        - MATCH_ALL
      fields:
        type: array
        description: Field names to search against
        items:
          type: string
        x-genesys-search-fields:
          value:
          - description
          - id
          - name
          - state
  Biography:
    type: object
    properties:
      biography:
        type: string
        description: Personal detailed description
      interests:
        type: array
        items:
          type: string
      hobbies:
        type: array
        items:
          type: string
      spouse:
        type: string
      education:
        type: array
        description: User education details
        items:
          $ref: '#/definitions/Education'
  UserAuthorization:
    type: object
    properties:
      roles:
        type: array
        items:
          $ref: '#/definitions/DomainRole'
      unusedRoles:
        type: array
        description: A collection of the roles the user is not using
        readOnly: true
        items:
          $ref: '#/definitions/DomainRole'
      permissions:
        type: array
        description: A collection of the permissions granted by all assigned roles
        readOnly: true
        items:
          type: string
      permissionPolicies:
        type: array
        description: The policies configured for assigned permissions.
        readOnly: true
        items:
          $ref: '#/definitions/ResourcePermissionPolicy'
  ResourcePermissionPolicy:
    type: object
    properties:
      id:
        type: string
      domain:
        type: string
      entityName:
        type: string
      policyName:
        type: string
      policyDescription:
        type: string
      actionSetKey:
        type: string
      allowConditions:
        type: boolean
      resourceConditionNode:
        $ref: '#/definitions/ResourceConditionNode'
      namedResources:
        type: array
        items:
          type: string
      resourceCondition:
        type: string
      actionSet:
        type: array
        uniqueItems: true
        items:
          type: string
  WritableDivision:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  GroupsSearchResponse:
    type: object
    required:
    - pageCount
    - pageNumber
    - pageSize
    - results
    - total
    - types
    properties:
      total:
        type: integer
        format: int64
        description: The total number of results found
      pageCount:
        type: integer
        format: int32
        description: The total number of pages
      pageSize:
        type: integer
        format: int32
        description: The current page size
      pageNumber:
        type: integer
        format: int32
        description: The current page number
      previousPage:
        type: string
        description: Q64 value for the previous page of results
      currentPage:
        type: string
        description: Q64 value for the current page of results
      nextPage:
        type: string
        description: Q64 value for the next page of results
      types:
        type: array
        description: Resource types the search was performed against
        items:
          type: string
      results:
        type: array
        description: Search results
        items:
          $ref: '#/definitions/Group'
  OutOfOffice:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      user:
        $ref: '#/definitions/User'
      startDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      endDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      active:
        type: boolean
      indefinite:
        type: boolean
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  UserPresence:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      source:
        type: string
        description: Deprecated - The sourceID field should be used as a replacement.
      sourceId:
        type: string
        description: Represents the ID of a registered source
      primary:
        type: boolean
        description: A boolean used to tell whether or not to set this presence source as the primary on a PATCH
      presenceDefinition:
        $ref: '#/definitions/PresenceDefinition'
      futurePresenceDefinition:
        description: The definition of the user's desired future presence
        readOnly: true
        $ref: '#/definitions/PresenceDefinition'
      message:
        type: string
      modifiedDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  LocationEmergencyNumber:
    type: object
    properties:
      e164:
        type: string
      number:
        type: string
      type:
        type: string
        description: The type of emergency number.
        enum:
        - default
        - elin
  UserEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/User'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  ErrorBody:
    type: object
    properties:
      message:
        type: string
      code:
        type: string
      status:
        type: integer
        format: int32
      entityId:
        type: string
      entityName:
        type: string
      messageWithParams:
        type: string
      messageParams:
        type: object
        additionalProperties:
          type: string
      contextId:
        type: string
      details:
        type: array
        items:
          $ref: '#/definitions/Detail'
      errors:
        type: array
        items:
          $ref: '#/definitions/ErrorBody'
      limit:
        $ref: '#/definitions/Limit'
  UserStations:
    type: object
    properties:
      associatedStation:
        description: Current associated station for this user.
        readOnly: true
        $ref: '#/definitions/UserStation'
      effectiveStation:
        description: The station where the user can be reached based on their default and associated station.
        readOnly: true
        $ref: '#/definitions/UserStation'
      defaultStation:
        description: Default station to be used if not associated with a station.
        readOnly: true
        $ref: '#/definitions/UserStation'
      lastAssociatedStation:
        description: Last associated station for this user.
        readOnly: true
        $ref: '#/definitions/UserStation'
  LocationImage:
    type: object
    properties:
      resolution:
        type: string
        description: 'Height and/or width of image. ex: 640x480 or x128'
      imageUri:
        type: string
  Division:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  GroupEntityListing:
    type: object
    properties:
      entities:
        type: array
        items:
          $ref: '#/definitions/Group'
      pageSize:
        type: integer
        format: int32
      pageNumber:
        type: integer
        format: int32
      total:
        type: integer
        format: int64
      firstUri:
        type: string
        format: uri
      nextUri:
        type: string
        format: uri
      previousUri:
        type: string
        format: uri
      lastUri:
        type: string
        format: uri
      selfUri:
        type: string
        format: uri
      pageCount:
        type: integer
        format: int32
  ResourceConditionNode:
    type: object
    properties:
      variableName:
        type: string
      conjunction:
        type: string
        enum:
        - AND
        - OR
      operator:
        type: string
        enum:
        - EQ
        - IN
        - GE
        - GT
        - LE
        - LT
      operands:
        type: array
        items:
          $ref: '#/definitions/ResourceConditionValue'
      terms:
        type: array
        items:
          $ref: '#/definitions/ResourceConditionNode'
  OAuthLastTokenIssued:
    type: object
    properties:
      dateIssued:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  EmployerInfo:
    type: object
    properties:
      officialName:
        type: string
      employeeId:
        type: string
      employeeType:
        type: string
      dateHire:
        type: string
  GroupProfile:
    type: object
    required:
    - version
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      state:
        type: string
        description: The state of the user resource
        enum:
        - active
        - inactive
        - deleted
      dateModified:
        type: string
        format: date-time
        description: 'Datetime of the last modification. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      version:
        type: integer
        format: int64
        description: The version of the group resource
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  PresenceDefinition:
    type: object
    properties:
      id:
        type: string
        description: description
      systemPresence:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  GroupSearchRequest:
    type: object
    properties:
      sortOrder:
        type: string
        description: The sort order for results
        enum:
        - ASC
        - DESC
        - SCORE
      sortBy:
        type: string
        description: The field in the resource that you want to sort the results by
      pageSize:
        type: integer
        format: int32
        description: The number of results per page
      pageNumber:
        type: integer
        format: int32
        description: The page of resources you want to retrieve
      sort:
        type: array
        description: Multi-value sort order, list of multiple sort values
        items:
          $ref: '#/definitions/SearchSort'
      query:
        type: array
        items:
          $ref: '#/definitions/GroupSearchCriteria'
  MediaSummary:
    type: object
    properties:
      contactCenter:
        $ref: '#/definitions/MediaSummaryDetail'
      enterprise:
        $ref: '#/definitions/MediaSummaryDetail'
  LocationAddressVerificationDetails:
    type: object
    properties:
      status:
        type: string
        description: Status of address verification process
        enum:
        - Pending
        - InProgress
        - Retry
        - Complete
        - Failed
      dateFinished:
        type: string
        format: date-time
        description: 'Finished time of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      dateStarted:
        type: string
        format: date-time
        description: 'Time started of address verification process. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      service:
        type: string
        example: smartystreets-us
        description: Third party service used for address verification
  LocationAddress:
    type: object
    properties:
      city:
        type: string
      country:
        type: string
      countryName:
        type: string
      state:
        type: string
      street1:
        type: string
      street2:
        type: string
      zipcode:
        type: string
  RoutingStatus:
    type: object
    properties:
      userId:
        type: string
        description: The userId of the agent
      status:
        type: string
        description: Indicates the Routing State of the agent.  A value of OFF_QUEUE will be returned if the specified user does not exist.
        enum:
        - OFF_QUEUE
        - IDLE
        - INTERACTING
        - NOT_RESPONDING
        - COMMUNICATING
      startTime:
        type: string
        format: date-time
        description: 'The timestamp when the agent went into this state. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
  UserStation:
    type: object
    properties:
      id:
        type: string
        description: A globally unique identifier for this station
        readOnly: true
      name:
        type: string
      type:
        type: string
      associatedUser:
        $ref: '#/definitions/User'
      associatedDate:
        type: string
        format: date-time
        description: 'Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
      defaultUser:
        $ref: '#/definitions/User'
      providerInfo:
        type: object
        description: 'Provider-specific info for this station, e.g. { "edgeGroupId": "ffe7b15c-a9cc-4f4c-88f5-781327819a49" }'
        additionalProperties:
          type: string
      webRtcCallAppearances:
        type: integer
        format: int32
        description: The number of call appearances on the station.
        readOnly: true
  ResourceConditionValue:
    type: object
    properties:
      type:
        type: string
        enum:
        - SCALAR
        - VARIABLE
        - USER
        - QUEUE
        - TEAM
      value:
        type: string
  FieldConfig:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      entityType:
        type: string
        enum:
        - person
        - group
        - org
      state:
        type: string
      sections:
        type: array
        items:
          $ref: '#/definitions/Section'
      version:
        type: string
      schemaVersion:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Group:
    type: object
    required:
    - name
    - rulesVisible
    - type
    - visibility
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The group name.
      description:
        type: string
      dateModified:
        type: string
        format: date-time
        description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      memberCount:
        type: integer
        format: int64
        description: Number of members.
        readOnly: true
      state:
        type: string
        description: Active, inactive, or deleted state.
        readOnly: true
        enum:
        - active
        - inactive
        - deleted
      version:
        type: integer
        format: int32
        description: Current version for this resource.
        readOnly: true
      type:
        type: string
        description: Type of group.
        enum:
        - official
        - social
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      addresses:
        type: array
        items:
          $ref: '#/definitions/GroupContact'
      rulesVisible:
        type: boolean
        description: Are membership rules visible to the person requesting to view the group
      visibility:
        type: string
        description: Who can view this group
        enum:
        - public
        - owners
        - members
      rolesEnabled:
        type: boolean
        description: Allow roles to be assigned to this group
      includeOwners:
        type: boolean
        description: Allow owners to be included as members of the group
      callsEnabled:
        type: boolean
        description: Allow calls to be placed to this group.
      owners:
        type: array
        description: Owners of the group
        items:
          $ref: '#/definitions/User'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Location:
    type: object
    properties:
      id:
        type: string
        description: Unique identifier for the location
      floorplanId:
        type: string
        description: Unique identifier for the location floorplan image
        readOnly: true
      coordinates:
        type: object
        description: Users coordinates on the floorplan. Only used when floorplanImage is set
        additionalProperties:
          type: number
          format: double
      notes:
        type: string
        description: Optional description on the users location
      locationDefinition:
        $ref: '#/definitions/LocationDefinition'
  Geolocation:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      type:
        type: string
        description: A string used to describe the type of client the geolocation is being updated from e.g. ios, android, web, etc.
      primary:
        type: boolean
        description: A boolean used to tell whether or not to set this geolocation client as the primary on a PATCH
      latitude:
        type: number
        format: double
      longitude:
        type: number
        format: double
      country:
        type: string
      region:
        type: string
      city:
        type: string
      locations:
        type: array
        items:
          $ref: '#/definitions/LocationDefinition'
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Empty:
    type: object
  GroupUpdate:
    type: object
    required:
    - version
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The group name.
      description:
        type: string
      state:
        type: string
        description: State of the group.
        enum:
        - active
        - inactive
        - deleted
      version:
        type: integer
        format: int32
        description: Current version for this resource.
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      addresses:
        type: array
        items:
          $ref: '#/definitions/GroupContact'
      rulesVisible:
        type: boolean
        description: Are membership rules visible to the person requesting to view the group
      visibility:
        type: string
        description: Who can view this group
        enum:
        - public
        - ownerIds
        - members
      rolesEnabled:
        type: boolean
        description: Allow roles to be assigned to this group
      includeOwners:
        type: boolean
        description: Allow owners to be included as members of the group
      callsEnabled:
        type: boolean
        description: Allow calls to be placed to this group.
      ownerIds:
        type: array
        description: Owners of the group
        items:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Limit:
    type: object
    properties:
      key:
        type: string
      namespace:
        type: string
        enum:
        - web.deployments
        - web.messaging
        - agent.assistant
        - agentic.virtual.agents
        - analytics.agents
        - analytics.alerting
        - analytics.data.extraction
        - analytics
        - analytics.realtime
        - analytics.reporting.settings
        - anomaly.detection
        - architect
        - audiohook
        - audiohook.monitor
        - audit
        - auth.api
        - authorization
        - automation.testing
        - bots
        - bots.voice
        - business.rules
        - callback
        - case.management
        - cobrowse
        - content.management
        - conversation
        - copilot
        - dataactions
        - datatables
        - directory
        - dsar
        - email
        - employee.engagement
        - event.orchestration
        - external.contacts
        - external.events.data.ingestion
        - gamification
        - gcv
        - gdpr
        - groups
        - guides
        - historical.adherence
        - infrastructureascode
        - integrations
        - intent.miner
        - internal.messaging
        - journey
        - knowledge
        - language.understanding
        - learning
        - limit.registry
        - marketplace
        - mcp.analytics.aggregates
        - mcp
        - media.communications
        - messaging
        - micro.frontend
        - multi.org
        - notifications
        - onboarding
        - outbound
        - platform.api
        - predictive.routing
        - presence
        - quality
        - recording
        - response.management
        - routing
        - scim
        - screen.monitoring
        - search
        - secondary.automation.testing
        - skills
        - social.media
        - speech.and.text.analytics
        - speech.integration
        - supportability
        - task.management
        - telephony.configuration
        - usage
        - users
        - users.rules
        - voice.transcription
        - webchat
        - webhooks
        - workforce.management.adherence
        - workforce.management.agent.availability
        - workforce.management.forecast
        - workforce.management
        - workforce.management.scheduling.preferences
        - workforce.management.self.schedule
        - workforce.management.shift.trading
        - system
      value:
        type: integer
        format: int64
  GroupCreate:
    type: object
    required:
    - name
    - rulesVisible
    - type
    - visibility
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
        description: The group name.
      description:
        type: string
      dateModified:
        type: string
        format: date-time
        description: 'Last modified date/time. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z'
        readOnly: true
      memberCount:
        type: integer
        format: int64
        description: Number of members.
        readOnly: true
      state:
        type: string
        description: Active, inactive, or deleted state.
        readOnly: true
        enum:
        - active
        - inactive
        - deleted
      version:
        type: integer
        format: int32
        description: Current version for this resource.
        readOnly: true
      type:
        type: string
        description: Type of group.
        enum:
        - official
        - social
      images:
        type: array
        items:
          $ref: '#/definitions/Image'
      addresses:
        type: array
        items:
          $ref: '#/definitions/GroupContact'
      rulesVisible:
        type: boolean
        description: Are membership rules visible to the person requesting to view the group
      visibility:
        type: string
        description: Who can view this group
        enum:
        - public
        - owners
        - members
      rolesEnabled:
        type: boolean
        description: Allow roles to be assigned to this group
      includeOwners:
        type: boolean
        description: Allow owners to be included as members of the group
      callsEnabled:
        type: boolean
        description: Allow calls to be placed to this group.
      ownerIds:
        type: array
        description: Owners of the group
        items:
          type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  UserRoutingLanguage:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      proficiency:
        type: number
        format: double
        description: A rating from 0.0 to 5.0 that indicates how fluent an agent is in a particular language. ACD interactions are routed to agents with higher proficiency ratings.
      state:
        type: string
        description: Activate or deactivate this routing language.
        enum:
        - active
        - inactive
        - deleted
      languageUri:
        type: string
        format: uri
        description: URI to the organization language used by this user language.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Represents an organization language assigned to a user. When assigning to a user specify the organization language id as the id.
  FieldList:
    type: object
    properties:
      customLabels:
        type: boolean
      instructionText:
        type: string
      key:
        type: string
      labelKeys:
        type: array
        items:
          type: string
      params:
        type: object
        additionalProperties:
          type: object
      repeatable:
        type: boolean
      state:
        type: string
      type:
        type: string
      required:
        type: boolean
      gdpr:
        type: boolean
  Section:
    type: object
    properties:
      fieldList:
        type: array
        items:
          $ref: '#/definitions/FieldList'
      instructionText:
        type: string
      key:
        type: string
      state:
        type: string
  DomainRole:
    type: object
    properties:
      id:
        type: string
        description: The ID of the role
      name:
        type: string
        description: The name of the role
  Chat:
    type: object
    properties:
      jabberId:
        type: string
  SearchSort:
    type: object
    properties:
      sortOrder:
        type: string
        description: The sort order for results
        enum:
        - ASC
        - DESC
        - SCORE
      sortBy:
        type: string
        description: The field in the resource that you want to sort the results by
  UserRoutingSkill:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      proficiency:
        type: number
        format: double
        description: A rating from 0.0 to 5.0 that indicates how adept an agent is at a particular skill. When "Best available skills" is enabled for a queue in Genesys Cloud, ACD interactions in that queue are routed to agents with higher proficiency ratings.
      state:
        type: string
        description: Activate or deactivate this routing skill.
        enum:
        - active
        - inactive
        - deleted
      skillUri:
        type: string
        format: uri
        description: URI to the organization skill used by this user skill.
        readOnly: true
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
    description: Represents an organization skill assigned to a user. When assigning to a user specify the organization skill id as the id.
  GroupContact:
    type: object
    required:
    - address
    - mediaType
    - type
    properties:
      address:
        type: string
        description: Phone number for this contact type
      extension:
        type: string
        description: Extension is set if the number is e164 valid
      display:
        type: string
        description: Formatted version of the address property
        readOnly: true
      type:
        type: string
        description: Contact type of the address
        enum:
        - GROUPRING
        - GROUPPHONE
      mediaType:
        type: string
        description: Media type of the address
        enum:
        - PHONE
  Contact:
    type: object
    properties:
      address:
        type: string
        description: Email address or phone number for this contact type
      display:
        type: string
        description: Formatted version of the address property
        readOnly: true
      mediaType:
        type: string
        enum:
        - PHONE
        - EMAIL
        - SMS
      type:
        type: string
        enum:
        - PRIMARY
        - WORK
        - WORK2
        - WORK3
        - WORK4
        - HOME
        - MOBILE
        - MAIN
        - OTHER
      extension:
        type: string
        description: Use internal extension instead of address. Mutually exclusive with the address field.
      countryCode:
        type: string
      integration:
        type: string
        example: microsoftteams
        description: Integration tag value if this number is associated with an external integration.
  LocationDefinition:
    type: object
    properties:
      id:
        type: string
        description: The globally unique identifier for the object.
        readOnly: true
      name:
        type: string
      contactUser:
        description: Site contact for the location entity
        $ref: '#/definitions/AddressableEntityRef'
      emergencyNumber:
        description: Emergency number for the location entity
        $ref: '#/definitions/LocationEmergencyNumber'
      address:
        $ref: '#/definitions/LocationAddress'
      state:
        type: string
        description: Current state of the location entity
        enum:
        - active
        - deleted
      notes:
        type: string
        description: Notes for the location entity
      version:
        type: integer
        format: int32
        description: Current version of the location entity, value to be supplied should be retrieved by a GET or on create/update response
      path:
        type: array
        description: A list of ancestor IDs in order
        readOnly: true
        items:
          type: string
      profileImage:
        type: array
        description: Profile image of the location entity, retrieved with ?expand=images query parameter
        readOnly: true
        items:
          $ref: '#/definitions/LocationImage'
      floorplanImage:
        type: array
        description: Floorplan images of the location entity, retrieved with ?expand=images query parameter
        readOnly: true
        items:
          $ref: '#/definitions/LocationImage'
      addressVerificationDetails:
        description: Address verification information, retrieve dwith the ?expand=addressVerificationDetails query parameter
        readOnly: true
        $ref: '#/definitions/LocationAddressVerificationDetails'
      addressVerified:
        type: boolean
        description: Boolean field which states if the address has been verified as an actual address
        readOnly: true
      addressStored:
        type: boolean
        description: Boolean field which states if the address has been stored for E911
        readOnly: true
      images:
        type: string
      selfUri:
        type: string
        format: uri
        description: The URI for this object
        readOnly: true
  Detail:
    type: object
    properties:
      errorCode:
        type: string
      fieldName:
        type: string
      entityId:
        type: string
      entityName:
        type: string
securityDefinitions:
  PureCloud OAuth:
    type: oauth2
    authorizationUrl: https://login.mypurecloud.com/authorize
    flow: implicit
    scopes:
      all: All the scopes
  Guest Chat JWT:
    type: apiKey
    name: Authorization
    in: header
externalDocs:
  description: PureCloud API Documentation
  url: https://developer.genesys.cloud/