Bulk - User bulk API | Webex for Developers

User bulk API

Authorization

OAuth token rendered by Identity Broker.

One of the following OAuth scopes is required:

identity:people_rw

Usage:

The input JSON must conform to the following schema: 'urn:ietf:params:scim:api:messages:2.0:BulkRequest'.
The request must be accompanied with a body in JSON format according to the standard SCIM schema definition. The maximum number of operations in a request is 100; an error is thrown if the limit is exceeded.
failOnErrors parameter
An integer specifies the number of errors that the service provider will accept before the operation is terminated and an error response is returned. It is OPTIONAL in a request. Maximum number of operations allowed to fail before the server stops processing the request. The value must be between 1 and 100.
operations parameter
Contains a list of bulk operations for POST/PATCH/DELETE operations. (REQUIRED)
- operations.method
  The HTTP method of the current operation. Possible values are POST, PATCH or DELETE.
- operations.path
  The Resource's relative path. If the method is POST the value must specify a Resource type endpoint; e.g., /Users or /Groups whereas all other method values must specify the path to a specific Resource; e.g., /Users/2819c223-7f76-453a-919d-413861904646.
- operations.data
  The Resource data as it would appear for a single POST or PATCH Resource operation. It is REQUIRED in a request when method is POST and PATCH. Refer to corresponding wiki for SCIM 2.0 POST, PATCH and DELETE API.
- operations.bulkId
  The transient identifier of a newly created resource, unique within a bulk request and created by the client. 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. It is REQUIRED when "method" is "POST".

POST/identity/scim/{orgId}/v2/Bulk

URI Parameters

orgId

stringrequired

Webex Identity assigned organization identifier for user's organization.

Body Parameters

schemas

array[string]required

Input JSON schemas.

Possible values: urn:ietf:params:scim:api:messages:2.0:BulkRequest

failOnErrors

numberrequired

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

array[object]required

Contains a list of bulk operations for POST/PATCH/DELETE operations.

method

enum

The HTTP method of the current operation.

POST

string

PATCH

string

DELETE

string

path

string

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.

Possible values: /Users/2819c223-7f76-453a-919d-413861904646

data

string

The Resource JSON data as it appears for a single POST or PATCH resource operation.

Possible values: JSON text

bulkId

string

The transient identifier of a newly created resource, unique within a bulk request and created by the client.

Possible values: ytrewq

Response Properties

schemas

array[string]

Input JSON schemas.

failOnErrors

number

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

array[object]

Contains a list of bulk operations for POST/PATCH/DELETE operations.

method

enum

The HTTP method of the current operation.

POST

string

PATCH

string

DELETE

string

path

string

Possible values: /Users/2819c223-7f76-453a-919d-413861904646

data

string

The Resource JSON data as it appears for a single POST or PATCH resource operation.

Possible values: JSON text

bulkId

string

The transient identifier of a newly created resource, unique within a bulk request and created by the client.

Possible values: ytrewq

Response Codes

The list below describes the common success and error responses you should expect from the API:

Code	Status	Description
200	OK	Successful request with body content.
201	Created	The request has succeeded and has led to the creation of a resource.
202	Accepted	The request has been accepted for processing.
204	No Content	Successful request without body content.
400	Bad Request	The request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401	Unauthorized	Authentication credentials were missing or incorrect.
403	Forbidden	The request is understood, but it has been refused or access is not allowed.
404	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	Method Not Allowed	The request was made to a resource using an HTTP request method that is not supported.
409	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	Gone	The requested resource is no longer available.
415	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	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	Precondition Required	File(s) cannot be scanned for malware and need to be force downloaded.
429	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	Internal Server Error	Something went wrong on the server. If the issue persists, feel free to contact the Webex Developer Support team.
502	Bad Gateway	The server received an invalid response from an upstream server while processing the request. Try again later.
503	Service Unavailable	Server is overloaded with requests. Try again later.
504	Gateway Timeout	An upstream server failed to respond on time. If your query uses `max` parameter, please try to reduce it.

POST

/identity/scim//v2/Bulk

Header

Content-Type
Authorization
Use personal access token
Bearer
This limited-duration personal access token is hidden for your security.

Body

schemas
arrayRequired
Input JSON schemas.
failOnErrors
numberRequired
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
arrayRequired
Contains a list of bulk operations for POST/PATCH/DELETE operations.

https://webexapis.com/identity/scim/0ae87ade-8c8a-4952-af08-318798958d0c/v2/Bulk

{
  "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"
    }
  ]
}

200 / OK

{
    "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"
        }
    ]
}