Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

Thales Logo

All

  • All
back

SCIM API

SCIM user management

search

SCIM user management

The SCIM API includes operations for retrieving, creating, updating, and deleting users. Users include the common attributes, core attributes, OneWelcome Identity Platform custom attributes, and your custom schema extension attributes.

Operations use OAuth scopes for authentication and authorization.

See also the unsupported SCIM features.

All response messages examples are shown in JSON format.

Retrieve users with GET

To reduce the number of returned results, you can use filtering. You can filter using one or more attribute operators, concatenated using AND or OR operators.

For details about retrieving users, see SCIM:Protocol 1:0 - Retrieving Resources section.

Retrieve a known user

Returns the SCIM attributes for the specified user.

  • Method: GET

  • Scope for OAuth bearer token authorization: SCIM:user:get

Example: Search for a user by name

    https://<domainURI>/scim/v1/Users?filter=(name.givenName co "Gustav") or (emails co "gustav")

List or query users

Returns a paginated list of users.

  • Method: GET

  • Scope for OAuth bearer token authorization: SCIM:user:query

Example: Retrieve user using filtering on custom attribute

    https://<domainURI>/scim/v1/Users?filter=urn:scim:schemas:extension:<customer>:1.0:customerid eq "123456789"

Example: GET user with OneWelcome schema extension

This example shows the following schemas and attributes:

  • OneWelcome schema extension with the segment (tenant) and state attributes

  • OneWelcome attribute metadata extension, which references attributes in the SCIM core schema, and the segment (tenant) and state attributes from the OneWelcome Identity Platform schema extension

Request
    GET : https://<domainURI>/scim/v1/Users/{upn}
Response
    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:24:17Z",
            "version": "W/1484195663",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "state",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "segment": "<customer>",
            "state": "INACTIVE"
        }
    }

Create users with POST

You can create resources using an OAuth bearer token with scope protection.

Differences between a user POST (protected with the SCIM:user:post scope for OAuth bearer token authorization) request and response:

  • An ID is added, which is required for updating and deleting the user.

  • Meta information is added. The version is of particular interest for updates.

  • When a user is created, the password value is not returned in the response.

For more details, refer to SCIM:Protocol 1.1 - Creating Resources section.

Example: Create a user with minimal information

The following request shows creating a user with only minimal information, because username is the only required field.

Request

    POST : https://<domainURI>/scim/v1/Users

      {
        "schemas": [
            "urn:scim:schemas:core:1.0"
         ],
         "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr"
          },
         "emails": [
            {
               "type": "other",
               "value": "gustav@gressmann.com",
               "primary": true
            }
         ]
      }

Response

The response message shows:

  • The generated ID for the new user

  • Metadata as specified by SCIM

  • Metadata as specified in the OneWelcome Identity Platform metadata attribute extension

  • The OneWelcome Identity Platform schema extension, including the state and segment (tenant) attributes

    "meta": {
        "created": "2018-06-05T15:24:17Z",
        "lastModified": "2018-06-05T15:24:17Z",
        "version": "W/1484195663",
        "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
    },
    "userName": "193f187d921c49e48d555257b6654b54",
    "name": {
        "familyName": "Gressmann",
        "givenName": "Gustav",
        "honorificPrefix": "mr",
        "formatted": "Gustav Gressmann"
    },
    "emails": [
        {
            "type": "other",
            "value": "gustav@gressmann.com",
            "primary": true
        }
    ],
    "id": "193f187d921c49e48d555257b6654b54",
    "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0",
        "urn:scim:schemas:extension:iwelcome:1.0",
        "urn:scim:schemas:extension:iwelcomeattributevaluemetadata:1.0"
    ],
    "active": false,
    "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
        "metadata": [
            {
                "changeDate": "2018-06-05T15:24:17Z",
                "attributeName": "userName",
                "trustLevel": "unverified",
                "createDate": "2018-06-05T15:24:17Z"
            },
            {
                "changeDate": "2018-06-05T15:24:17Z",
                "attributeName": "emails",
                "createDate": "2018-06-05T15:24:17Z"
            },
            {
                "changeDate": "2018-06-05T15:24:17Z",
                "attributeName": "name",
                "createDate": "2018-06-05T15:24:17Z"
            },
            {
                "changeDate": "2018-06-05T15:24:17Z",
                "attributeName": "id",
                "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "state",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "segment": "<customer>",
            "state": "INACTIVE"
        },
        "urn:scim:schemas:extension:iwelcomeattributevaluemetadata:1.0": {
            "attributevaluemetadata": []
        }

Update users with PUT and PATCH

You can update users with PUT and PATCH HTTP methods, which are protected with scopes for OAuth bearer token authorization:

  • PUT is protected with the SCIM:user:put scope. Use PUT to completely replace all attributes for a user.

  • PATCH is protected with the SCIM:user:patch scope. Use PATCH to update only specific user attributes.

Example: Change password

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

       {
            "schemas":  [
                "urn:scim:schemas:core:1.0"],
                "password": "RFKh48KaHR4"
        }

Example: Change password using bcrypt

Note

Using the bcrypt algorithm is optional. You need to do some configuration before you can use it.

In this PATCH example, a user's password needs to be updated to Ne@am!ros, and the hashed value using the bcrypt algorithm is $2a$10$4pmvJAAZuTW7mmaVuzyDaeIPL77nB/zTsOsy5bE5eYj3XjMlATbBy.

To hash passwords using the bcrypt algorithm for testing purposes, use the following site: https://www.bcrypt-generator.com.

Request

After the OneWelcome Identity Platform successfully processes this request, the user can log in using the password Ne@am!ros.

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

       {
            "schemas":  [
                "urn:scim:schemas:core:1.0"],
            "password": "{bcrypt}$2a$10$4pmvJAAZuTW7mmaVuzyDaeIPL77nB/zTsOsy5bE5eYj3XjMlATbBy"
        }

Example: Update a singular simple attribute

This example request uses PATCH to update a singular, simple attribute that is defined in a custom schema extension.

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

    {
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:<customer>:1.0"
        ],
        "urn:scim:schemas:extension:<customer>:1.0": {
            "myCustomerAttribute": "Other"
        }
    }

Example: Add additional email addresses

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

       {
            "schemas": ["urn:scim:schemas:core:1.0"],
            "emails":    [
                    {
                "type": "work",
                "primary": false,
                "value": "multiwork@example-mail.com"
              },
                    {
                "type": "home",
                "primary": false,
                "value": "multihome@example-mail.com"
              }
            ]
        }

Example: Update familyName

This example request uses PATCH to update the familyName, which is a singular, complex attribute.

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

        {
            "schemas": [
                "urn:scim:schemas:core:1.0"
            ],
            "name": {
                "familyName": "Gressman"
            }
        }

Example: Add two addresses

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

        {
            "schemas": ["urn:scim:schemas:core:1.0"],
            "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted" : "Soesterweg 300E, 3812 BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality" : "Amersfoort",
                "region" : "Utrecht",
                "postalCode" : "3812 BH",
                "country" : "NL"
            },
            {
                "streetAddress": "Kerkenbos 10-53 D",
                "formatted" : "Soesterweg 300E, 6546 BB, Nijmegen",
                "primary": false,
                "type": "work",
                "locality" : "Nijmegen",
                "region" : "Gelderland",
                "postalCode" : "6546 BB",
                "country" : "NL"
            }
        ]
        }

Response

    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:30:27Z",
            "version": "W/1820932903",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted": "Soesterweg 300E, 3812 BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality": "Amersfoort",
                "region": "Utrecht",
                "postalCode": "3812 BH",
                "country": "NL"
            },
            {
                "streetAddress": "Kerkenbos 10-53 D",
                "formatted": "Soesterweg 300E, 6546 BB, Nijmegen",
                "primary": false,
                "type": "work",
                "locality": "Nijmegen",
                "region": "Gelderland",
                "postalCode": "6546 BB",
                "country": "NL"
            }
        ],
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                     "changeDate": "2018-06-05T15:24:17Z",
                     "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                     "attributeName": "state",
                     "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "addresses",
                    "createDate": "2018-06-05T15:30:27Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:30:27Z"
                }
            ]
                },
                "urn:scim:schemas:extension:iwelcome:1.0": {
                    "segment": "<customer>",
                    "state": "INACTIVE"
                }
            }

Example: Delete one address

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}
        {
            "schemas": ["urn:scim:schemas:core:1.0"],
        "addresses": [
             {
                "streetAddress": "Kerkenbos 10-53 D",
                "formatted" : "Soesterweg 300E, 6546 BB, Nijmegen",
                "primary": false,
                "type": "work",
                "locality" : "Nijmegen",
                "region" : "Gelderland",
                "postalCode" : "6546 BB",
                "country" : "NL",
                "operation": "delete"
            }
        ]
        }

Response

    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:30:27Z",
            "version": "W/1820932903",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted": "Soesterweg 300E, 3812 BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality": "Amersfoort",
                "region": "Utrecht",
                "postalCode": "3812 BH",
                "country": "NL"
            }
        ],
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "state",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "addresses",
                    "createDate": "2018-06-05T15:30:27Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:30:27Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "segment": "<customer>",
            "state": "INACTIVE"
        }
    }

Example: Change one address

This example request uses PATCH to change an address, which is a multi-valued, complex attribute.

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}

    {
      "schemas": ["urn:scim:schemas:core:1.0"],
    "addresses": [
        {
            "streetAddress": "Soesterweg 300E",
            "formatted": "Soesterweg 300E, 3812 BH, Amersfoort",
            "primary": true,
            "type": "work",
            "locality": "Amersfoort",
            "region": "Utrecht",
            "postalCode": "3812 BH",
            "country": "NL",
            "operation": "delete"
        },
        {
            "streetAddress": "Soesterweg 300E",
            "formatted": "Soesterweg 300E, 3812BH, Amersfoort",
            "primary": true,
            "type": "work",
            "locality": "Amersfoort",
            "region": "Utrecht",
            "postalCode": "3812BH",
            "country": "NL"
        }
    ]
    }

Response

    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:30:27Z",
            "version": "W/1820932903",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted": "Soesterweg 300E, 3812BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality": "Amersfoort",
                "region": "Utrecht",
                "postalCode": "3812BH",
                "country": "NL"
            }
        ],
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "state",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "addresses",
                    "createDate": "2018-06-05T15:30:27Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:30:27Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "segment": "<customer>",
            "state": "INACTIVE"
        }
    }

Example: Block a user

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}/"

    {
        "schemas":    [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0"
        ],
        "urn:scim:schemas:extension:iwelcome:1.0": {
        "blocks":
            [ {
                "userid": "some service desk user's ID",
                "reason": "some_block_reason"
            } ]
        }
    }

Response

    PATCH : https://<domainURI>/scim/v1/Users/{upn}/"

    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:38:06Z",
            "version": "W/1297329073",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted": "Soesterweg 300E, 3812 BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality": "Amersfoort",
                "region": "Utrecht",
                "postalCode": "3812 BH",
                "country": "NL"
            }
        ],
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27.547Z",
                    "attributeName": "addresses",
                    "createDate": "2018-06-05T15:30:27.547Z"
                },
                {
                    "changeDate": "2018-06-05T15:38:06Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "state",
                    "trustLevel": null,
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:38:06Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "blocks",
                    "createDate": "2018-06-05T15:38:06Z"
                },
                {
                    "changeDate": "2018-06-05T15:38:06Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:38:06Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "blocks": [
                {
                    "userid": "some service desk user's ID",
                    "reason": "some_block_reason",
                    "date": "2018-06-05T15:38:06.026Z"
                }
            ],
            "segment": "<customer>",
            "state": "WITHDRAWN"
        }
    }

Example: Remove a block

A user can have one or multiple blocks. The following example request removes a single block.

If no blocks remain, the state and active attributes change.

Request

    PATCH : https://<domainURI>/scim/v1/Users/{upn}/

    {
        "schemas":    [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0"
        ],
        "urn:scim:schemas:extension:iwelcome:1.0": {
        "blocks":
            [ {
                "userid": "some service desk user's ID",
                "reason": "some_block_reason",
                "date": "2018-06-05T15:38:06.026Z",
                "operation": "delete"
            } ]
        }
    }

Response

    {
        "meta": {
            "created": "2018-06-05T15:24:17Z",
            "lastModified": "2018-06-05T15:40:41Z",
            "version": "W/-2134981717",
            "location": "https://&lt;domainURI>/scim/v1/Users/193f187d921c49e48d555257b6654b54"
        },
        "userName": "193f187d921c49e48d555257b6654b54",
        "name": {
            "familyName": "Gressmann",
            "givenName": "Gustav",
            "honorificPrefix": "mr",
            "formatted": "Gustav Gressmann"
        },
        "addresses": [
            {
                "streetAddress": "Soesterweg 300E",
                "formatted": "Soesterweg 300E, 3812 BH, Amersfoort",
                "primary": true,
                "type": "work",
                "locality": "Amersfoort",
                "region": "Utrecht",
                "postalCode": "3812 BH",
                "country": "NL"
            }
        ],
        "emails": [
            {
                "type": "other",
                "value": "gustav@gressmann.com",
                "primary": true
            }
        ],
        "id": "193f187d921c49e48d555257b6654b54",
        "schemas": [
            "urn:scim:schemas:core:1.0",
            "urn:scim:schemas:extension:iwelcome:1.0",
            "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0"
        ],
        "active": false,
        "urn:scim:schemas:extension:iwelcomeattributemetadata:1.0": {
            "metadata": [
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "userName",
                    "trustLevel": "unverified",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:40:41Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "blocks",
                    "trustLevel": null,
                    "createDate": "2018-06-05T15:38:06Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "emails",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "id",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "attributeName": "name",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:30:27Z",
                    "attributeName": "addresses",
                    "createDate": "2018-06-05T15:30:27Z"
                },
                {
                    "changeDate": "2018-06-05T15:40:41Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "state",
                    "trustLevel": null,
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:24:17Z",
                    "extensionName": "urn:scim:schemas:extension:iwelcome:1.0",
                    "attributeName": "segment",
                    "createDate": "2018-06-05T15:24:17Z"
                },
                {
                    "changeDate": "2018-06-05T15:40:41Z",
                    "attributeName": "active",
                    "createDate": "2018-06-05T15:40:41Z"
                }
            ]
        },
        "urn:scim:schemas:extension:iwelcome:1.0": {
            "blocks": [],
            "segment": "<customer>",
            "state": "INACTIVE"
        }
    }

On this page