Jump to

• Request
• Response

Create a Bulk Request

post

/admin/v1/Bulk

Request

Supported Media Types

• application/scim+json
• application/json

Header Parameters

• Authorization: string
  The Authorization field value consists of credentials that contain the authentication information of the user agent for the realm of the resource being requested.
• Content-Type: string
  Media Type

Body ()

Root Schema : Bulk

Type: object

Make bulk requests to create, replace, update, delete resources of any type. Enables clients to send a potentially large collection of resource operations in a single request. This REST API is SCIM compliant.

Show Source

• Operations: array Operations
  The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
• schemas: array schemas
  SCIM++ Properties:
  

  • caseExact: false
  • idaasSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none

  REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \"enterprise\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

{
    "description":"Make bulk requests to create, replace, update, delete resources of any type. Enables clients to send a potentially large collection of resource operations in a single request. This REST API is SCIM compliant.",
    "type":"object",
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idaasSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \\\"enterprise\\\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior."
        },
        "Operations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Bulk-Operations"
            },
            "description":"The body of an HTTP PATCH request MUST contain the attribute \"Operations\", whose value is an array of one or more patch operations."
        }
    },
    "required":[
        "schemas",
        "Operations"
    ]
}

Nested Schema : Operations

Type: array

The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.

Show Source

• Array of: object Bulk-Operations
  Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Bulk-Operations"
    },
    "description":"The body of an HTTP PATCH request MUST contain the attribute \"Operations\", whose value is an array of one or more patch operations."
}

Nested Schema : schemas

Type: array

SCIM++ Properties:

• caseExact: false
• idaasSearchable: false
• multiValued: true
• mutability: readWrite
• required: true
• returned: default
• type: string
• uniqueness: none

REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \"enterprise\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:BulkRequest" ]

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
    ],
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idaasSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \\\"enterprise\\\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior."
}

Nested Schema : Bulk-Operations

Type: object

Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.

Show Source

• bulkId(optional): string
  SCIM++ Properties:
  

  • type: string

  The transient identifier of a newly created resource that is unique within a bulk request and is created by the client. The bulkId serves as a surrogate resource ID that enables clients to uniquely identify newly created resources in the response. It also enables clients to cross reference new resources in and across operations within a bulk request. REQUIRED when the method is POST.
• data(optional): object data
  SCIM++ Properties:
  

  • type: object

  The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH.
• method(optional): string
  Allowed Values: [ "POST", "PUT", "PATCH", "DELETE" ]

  SCIM++ Properties:
  

  • required: true
  • type: string

  The HTTP method of the current operation. Possible values are: 'POST', 'PUT', 'PATCH', or 'DELETE'.
• path(optional): string
  SCIM++ Properties:
  

  • required: true
  • type: string

  The resource's relative path to the SCIM service provider's root. If the method is POST, the value must specify a resource type endpoint, such as: /Users or /Groups. All other method values must specify the path to a specific resource, such as /Users/2819c223-7f76-453a-919d-413861904646.

{
    "type":"object",
    "description":"Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.",
    "properties":{
        "method":{
            "type":"string",
            "enum":[
                "POST",
                "PUT",
                "PATCH",
                "DELETE"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>required: true</li>  <li>type: string</li></ul>The HTTP method of the current operation. Possible values are: 'POST', 'PUT', 'PATCH', or 'DELETE'."
        },
        "bulkId":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li></ul>The transient identifier of a newly created resource that is unique within a bulk request and is created by the client. The bulkId serves as a surrogate resource ID that enables clients to uniquely identify newly created resources in the response. It also enables clients to cross reference new resources in and across operations within a bulk request. REQUIRED when the method is POST."
        },
        "path":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>required: true</li>  <li>type: string</li></ul>The resource's relative path to the SCIM service provider's root. If the method is POST, the value must specify a resource type endpoint, such as: /Users or /Groups. All other method values must specify the path to a specific resource, such as /Users/2819c223-7f76-453a-919d-413861904646."
        },
        "data":{
            "type":"object",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: object</li></ul>The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH."
        }
    }
}

Nested Schema : data

Type: object

SCIM++ Properties:

• type: object

The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH.

Back to Top

Response

Supported Media Types

• application/json
• application/scim+json

201 Response

Request successful. Bulk operations have been processed.

Body ()

Root Schema : Bulk

Type: object

Make bulk requests to create, replace, update, delete resources of any type. Enables clients to send a potentially large collection of resource operations in a single request. This REST API is SCIM compliant.

Show Source

• Operations: array Operations
  The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.
• schemas: array schemas
  SCIM++ Properties:
  

  • caseExact: false
  • idaasSearchable: false
  • multiValued: true
  • mutability: readWrite
  • required: true
  • returned: default
  • type: string
  • uniqueness: none

  REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \"enterprise\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

{
    "description":"Make bulk requests to create, replace, update, delete resources of any type. Enables clients to send a potentially large collection of resource operations in a single request. This REST API is SCIM compliant.",
    "type":"object",
    "properties":{
        "schemas":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "enum":[
                "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idaasSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \\\"enterprise\\\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior."
        },
        "Operations":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Bulk-Operations"
            },
            "description":"The body of an HTTP PATCH request MUST contain the attribute \"Operations\", whose value is an array of one or more patch operations."
        }
    },
    "required":[
        "schemas",
        "Operations"
    ]
}

Nested Schema : Operations

Type: array

The body of an HTTP PATCH request MUST contain the attribute "Operations", whose value is an array of one or more patch operations.

Show Source

• Array of: object Bulk-Operations
  Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Bulk-Operations"
    },
    "description":"The body of an HTTP PATCH request MUST contain the attribute \"Operations\", whose value is an array of one or more patch operations."
}

Nested Schema : schemas

Type: array

SCIM++ Properties:

• caseExact: false
• idaasSearchable: false
• multiValued: true
• mutability: readWrite
• required: true
• returned: default
• type: string
• uniqueness: none

REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \"enterprise\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior.

Allowed Values: [ "urn:ietf:params:scim:api:messages:2.0:BulkRequest" ]

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "enum":[
        "urn:ietf:params:scim:api:messages:2.0:BulkRequest"
    ],
    "description":"<b>SCIM++ Properties:</b><br/><ul><li>caseExact: false</li><li>idaasSearchable: false</li><li>multiValued: true</li><li>mutability: readWrite</li><li>required: true</li><li>returned: default</li><li>type: string</li><li>uniqueness: none</li></ul>REQUIRED. The schemas attribute is an array of strings which allows introspection of the supported schema version for a SCIM representation as well any schema extensions supported by that representation. Each string value must be a unique URI. This specification defines URIs for the User, Group, and a standard \\\"enterprise\\\" extension. All representations of the SCIM schema MUST include a non-zero value array with value(s) of the URIs supported by that representation. Duplicate values MUST NOT be included. Value order is not specified and MUST not impact behavior."
}

Nested Schema : Bulk-Operations

Type: object

Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.

Show Source

• bulkId(optional): string
  SCIM++ Properties:
  

  • type: string

  The transient identifier of a newly created resource that is unique within a bulk request and is created by the client. The bulkId serves as a surrogate resource ID that enables clients to uniquely identify newly created resources in the response. It also enables clients to cross reference new resources in and across operations within a bulk request. REQUIRED when the method is POST.
• data(optional): object data
  SCIM++ Properties:
  

  • type: object

  The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH.
• method(optional): string
  Allowed Values: [ "POST", "PUT", "PATCH", "DELETE" ]

  SCIM++ Properties:
  

  • required: true
  • type: string

  The HTTP method of the current operation. Possible values are: 'POST', 'PUT', 'PATCH', or 'DELETE'.
• path(optional): string
  SCIM++ Properties:
  

  • required: true
  • type: string

  The resource's relative path to the SCIM service provider's root. If the method is POST, the value must specify a resource type endpoint, such as: /Users or /Groups. All other method values must specify the path to a specific resource, such as /Users/2819c223-7f76-453a-919d-413861904646.

{
    "type":"object",
    "description":"Defines operations within a bulk request. Each operation corresponds to a single HTTP request against a resource endpoint.",
    "properties":{
        "method":{
            "type":"string",
            "enum":[
                "POST",
                "PUT",
                "PATCH",
                "DELETE"
            ],
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>required: true</li>  <li>type: string</li></ul>The HTTP method of the current operation. Possible values are: 'POST', 'PUT', 'PATCH', or 'DELETE'."
        },
        "bulkId":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: string</li></ul>The transient identifier of a newly created resource that is unique within a bulk request and is created by the client. The bulkId serves as a surrogate resource ID that enables clients to uniquely identify newly created resources in the response. It also enables clients to cross reference new resources in and across operations within a bulk request. REQUIRED when the method is POST."
        },
        "path":{
            "type":"string",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>required: true</li>  <li>type: string</li></ul>The resource's relative path to the SCIM service provider's root. If the method is POST, the value must specify a resource type endpoint, such as: /Users or /Groups. All other method values must specify the path to a specific resource, such as /Users/2819c223-7f76-453a-919d-413861904646."
        },
        "data":{
            "type":"object",
            "description":"<b>SCIM++ Properties:</b><br/><ul><li>type: object</li></ul>The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH."
        }
    }
}

Nested Schema : data

Type: object

SCIM++ Properties:

• type: object

The resource data as it would appear for a single POST, PUT, or PATCH resource operation. REQUIRED in a request when the method is POST, PUT, or PATCH.

401 Response

The supplied credentials, if any, are not sufficient to access the resource.

500 Response

We couldn't return the representation due to an internal server error.

Back to Top