openapi: 3.0.0
info:
  title: Webex Admin Address Book Bulk Manage SCIM 2 Users and Groups API
  version: 1.0.0
  description: The Webex Admin APIs provide comprehensive programmatic access to administrative functions for managing Webex organizations, users, licenses, and settings. These APIs enable automation of user provisioning, license assignment, compliance management, and audit event retrieval. Administrators can integrate with enterprise identity systems, enforce security policies, monitor usage, and streamline onboarding/offboarding processes. The APIs support granular control over organizational resources, making them ideal for large-scale deployments and custom admin tooling.
tags:
- name: Bulk Manage SCIM 2 Users and Groups
paths:
  /identity/scim/{orgId}/v2/Bulk:
    post:
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUser'
              example:
                schemas:
                - urn:ietf:params:scim:api:messages:2.0:BulkResponse
                Operations:
                - location: https://example.com/v2/Users/92b725cd-9465-4e7d-8c16-01f8e146b87a
                  method: POST
                  bulkId: qwerty
                  version: W/"oY4m4wn58tkVjJxK"
                  status: '201'
                - location: https://example.com/v2/Users/5d8d29d3-342c-4b5f-8683-a3cb6763ffcc
                  method: PATCH
                  version: W/"huJj29dMNgu3WXPD"
                  status: '200'
                - location: https://example.com/v2/Users/e9025315-6bea-44e1-899c-1e07454e468b
                  method: DELETE
                  status: '204'
        '400':
          description: 'Bad Request: The request was invalid or cannot be otherwise served. An accompanying error message will explain further.'
        '401':
          description: 'Unauthorized: Authentication credentials were missing or incorrect.'
        '403':
          description: 'Forbidden: The request is understood, but it has been refused or access is not allowed.'
        '404':
          description: 'Not Found: The URI requested is invalid or the resource requested, such as a user, does not exist. Also returned when the requested format is not supported by the requested method.'
        '405':
          description: 'Method Not Allowed: The request was made to a resource using an HTTP request method that is not supported.'
        '409':
          description: 'Conflict: The request could not be processed because it conflicts with some established rule of the system. For example, a person may not be added to a room more than once.'
        '410':
          description: 'Gone: The requested resource is no longer available.'
        '415':
          description: 'Unsupported Media Type: The request was made to a resource without specifying a media type or used a media type that is not supported.'
        '423':
          description: 'Locked: The requested resource is temporarily unavailable. A Retry-After header may be present that specifies how many seconds you need to wait before attempting the request again.'
        '428':
          description: 'Precondition Required: File(s) cannot be scanned for malware and need to be force downloaded.'
        '429':
          description: 'Too Many Requests: Too many requests have been sent in a given amount of time and the request has been rate limited. A Retry-After header should be present that specifies how many seconds you need to wait before a successful request can be made.'
        '500':
          description: 'Internal Server Error: Something went wrong on the server. If the issue persists, feel free to contact the [Webex Developer Support team](/explore/support).'
        '502':
          description: 'Bad Gateway: The server received an invalid response from an upstream server while processing the request. Try again later.'
        '503':
          description: 'Service Unavailable: Server is overloaded with requests. Try again later.'
        '504':
          description: 'Gateway Timeout: An upstream server failed to respond on time. If your query uses max parameter, please try to reduce it.'
      summary: User bulk API
      operationId: User bulk API
      description: "<br/>\n\n**Authorization**\n\nOAuth token rendered by Identity Broker.\n\n<br/>\n\nOne of the following OAuth scopes is required:\n\n- `identity:people_rw`\n\n<br/>\n\n**Usage**:\n\n1. The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.\n\n1. The request must be accompanied with a body in JSON format according to the standard SCIM schema definition.\n   The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.\n\n1. `failOnErrors` parameter\n\n   An integer specifies the number of errors that the service provider will accept before the operation is terminated and an error response is returned.\n   It is OPTIONAL in a request.\n   Maximum number of operations allowed to fail before the server stops processing the request. The value must be between 1 and 100.\n\n1. `operations` parameter\n\n   Contains a list of bulk operations for POST/PATCH/DELETE operations. (REQUIRED)\n    + `operations.method`\n\n      The HTTP method of the current operation. Possible values are POST, PATCH or DELETE.\n    + `operations.path`\n\n      The Resource's relative path. If the method is POST the value must specify a Resource type endpoint;\n      e.g., /Users or /Groups whereas all other method values must specify the path to a specific Resource;\n      e.g., /Users/2819c223-7f76-453a-919d-413861904646.\n    + `operations.data`\n\n      The Resource data as it would appear for a single POST or PATCH Resource operation.\n      It is REQUIRED in a request when method is POST and PATCH.\n      Refer to corresponding wiki for SCIM 2.0 POST, PATCH and DELETE API.\n    + `operations.bulkId`\n\n      The transient identifier of a newly created resource, unique within a bulk request and created by the client.\n      The bulkId serves as a surrogate resource id enabling clients to uniquely identify newly created resources in the response and cross-reference new resources in and across operations within a bulk request.\n      It is REQUIRED when \"method\" is \"POST\"."
      tags:
      - Bulk Manage SCIM 2 Users and Groups
      parameters:
      - name: orgId
        in: path
        description: Webex Identity assigned organization identifier for user's organization.
        required: true
        example: 0ae87ade-8c8a-4952-af08-318798958d0c
        schema:
          type: string
      requestBody:
        content:
          application/json:
            example:
              schemas:
              - urn:ietf:params:scim:api:messages:2.0:BulkRequest
              failOnErrors: 99
              operations:
              - method: PATCH
                path: /Users/2819c223-7f76-453a-919d-413861904646
                data: JSON text
                bulkId: ytrewq
            schema:
              $ref: '#/components/schemas/BulkUser'
components:
  schemas:
    BulkUser:
      type: object
      required:
      - schemas
      - failOnErrors
      - operations
      properties:
        schemas:
          type: array
          items:
            type: string
            example: urn:ietf:params:scim:api:messages:2.0:BulkRequest
          description: Input JSON schemas.
        failOnErrors:
          type: number
          example: 99
          description: An integer specifying the maximum number of errors that the service provider will accept before the operation is terminated and an error response is returned.
        operations:
          type: array
          items:
            type: object
            required:
            - method
            - path
            properties:
              method:
                type: string
                enum:
                - POST
                - PATCH
                - DELETE
                description: The HTTP method of the current operation.
              path:
                type: string
                example: /Users/2819c223-7f76-453a-919d-413861904646
                description: The resource's relative path. If the method is POST, the value must specify a resource type endpoint, for example `/Users` or `/Groups`. All other method values must specify the path to a specific resource.
              data:
                type: string
                example: JSON text
                description: The Resource JSON data as it appears for a single POST or PATCH resource operation.
              bulkId:
                type: string
                example: ytrewq
                description: The transient identifier of a newly created resource, unique within a bulk request and created by the client.
          description: Contains a list of bulk operations for POST/PATCH/DELETE operations.
  securitySchemes:
    oauth2:
      flows:
        authorizationCode:
          authorizationUrl: /
          scopes: {}
          tokenUrl: /
      type: oauth2
    bearer-key:
      type: http
      description: e.g. Bearer YOUR_AUTHORIZATION_TOKEN
      scheme: bearer
      bearerFormat: JWT
    bearerAuth:
      type: oauth2
      description: OAuth 2.0 Bearer token authentication
      flows:
        authorizationCode:
          authorizationUrl: https://webexapis.com/v1/authorize
          tokenUrl: https://webexapis.com/v1/access_token
          scopes:
            spark:applications_token: Create access tokens for Service Apps