SCIM API for User Replacement
2 months ago

SCIM API for User Replacement

Use the SCIM API to replace a user.

Authentication

Authorization: Bearer <Client Secret>

Use the copied Client Secret key as the Authorization key value.

Request Requirements

Method Request URLResponse Content TypeResponse BodyResponse Codes
PUT

<Base URI>/Users/id

application/scim+json

User details200, 400, 404, 405, 409, 500

Example Request Data

PUT <Base URI>/"<id>"

Authorization: Bearer 29da0602f6db1ed033aa91d644ce4d70bdf3ab58

Content-Type: application/scim+json

Example Request Body

The following examples display a user replacement request.

Full User Request

{
    "userName": "User One",
    "userType": "Senior Employee",
    "active": true,
    "addresses": [{
            "primary": true,
            "type": "work",
            "streetAddress": "Address 1",
            "locality": "Address 2",
            "region": "Address 3",
            "postalCode": "000000",
            "country": "country name"
        }
    ],
    "displayName": "User One",
    "emails": [{
            "type": "work",
            "value": "user.one@example.com",
            "primary": true
        }
    ],
    "locale": "EN_US",
    "name": {
        "givenName": "User",
        "familyName": "family_cloud",
        "formatted": "User One"
    },
    "nickName": "User",
    "phoneNumbers": [{
            "type": "work",
            "value": "+31 65 7777777",
            "primary": true
        }, {
            "type": "mobile",
            "value": "+31 65 8888888"
        }
    ],
    "preferredLanguage": "English",
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "title": "W965EL5C4URX"
}

Partial User Request

{
    "userName": "user_one123",
    "displayName": "User One",
    "emails": [{
            "type": "work",
            "value": "user.one@example.com",
            "primary": true
        }
    ],
    "name": {
        "givenName": "User",
        "familyName": "family_cloud",
        "formatted": "User One"
    },
    "phoneNumbers": [{
            "type": "work",
            "value": "+31 65 7777777",
            "primary": true
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
}

Request Body Parameters

See the SCIM Attributes section for the request parameters.

Response

The API returns the user details.

Example Response

Full User Request

{
    "userName": "User One",
    "userType": "Senior Employee",
    "active": true,
    "addresses": [{
            "primary": true,
            "type": "work",
            "streetAddress": "Address 1",
            "locality": "Address 2",
            "region": "Address 3",
            "postalCode": "000000",
            "country": "Country 1"
        }
    ],
    "displayName": "User One",
    "emails": [{
            "type": "work",
            "value": "user.one@example.com",
            "primary": true
        }
    ],
    "locale": "EN_US",
    "name": {
        "givenName": "User",
        "familyName": "family_cloud",
        "formatted": "User One"
    },
    "nickName": "user",
    "phoneNumbers": [{
            "type": "work",
            "value": "+31 65 7777777",
            "primary": true
        }, {
            "type": "mobile",
            "value": "+31 65 8888888"
        }
    ],
    "preferredLanguage": "English",
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
}

Partial User Request

{
    "userName": "user_one123",
    "displayName": "User One",
    "emails": [{
            "type": "work",
            "value": "user.one@example.com",
            "primary": true
        }
    ],
    "name": {
        "givenName": "User",
        "familyName": "family_cloud",
        "formatted": "User One"
    },
    "phoneNumbers": [{
            "type": "work",
            "value": "+31 65 7777777",
            "primary": true
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ]
}

Response Property Descriptions

See SCIM Attributes.

Response Codes

The following table shows response codes for this API.

CodeDescription
200OK
400

Bad Data

  • Error message examples:

  • Could not update user. Attribute userName is required and must have a value.

  • Could not update user. Password policy violated.

  • Could not update user. password already exists.

  • Could not update user. email is invalid.

  • Could not update user. Attribute email is required and must have a value.

  • Could not update user. Attribute email is required and must have a value.

  • User update failed.

{

Value for attribute schemas must contain schema URI urn:ietf:params:scim:schemas:core:2.0:User because it is the core schema for this resource type, Schema URI urn:ietf:params:scim:schemas:core:2.0:Userss is not a valid value for attribute schemas[0] because it is undefined as a core or schema extension for this resource type.

}

  • User update failed.

{

Schema URI urn:ietf:params:scim:schemas:extension:enterpriser:2.0:User is not a valid value for attribute schemas[1] because it is undefined as a core or schema extension for this resource type

}

  • User update failed.

{

Value for attribute schemas must contain schema URI urn:ietf:params:scim:schemas:core:2.0:User because it is the core schema for this resource type, Attribute schemas is required and must have a value.

}

  • User update failed.

{

Value test is not valid for attribute emails[0].type because it is not one of the canonical types: other, work, home.

}

User update failed.

{

Value help is not valid for attribute phoneNumbers[0].type because it is not one of the canonical types: other, pager, work, mobile, fax, home.

}

  • User update failed.

{

Value test is not valid for attribute emails[0].type because it is not one of the canonical types: other, work, home, Attribute userName is required and must have a value.

}

  • User update failed.

{

Extended attributes namespace urn:ietf:params:scim:schemas:extension:enterprise:2.0:User must be included in the schemas attribute.

}

404

Not Found

Error message example:

  • User with id: {{User ID}} not found in identity source {{Identity Source ID}}

405

Method Not Allowed (for Local identity source types).

409

Conflict

Error message examples:

  • Could not update user. userName is already in use.

  • Could not update user. email is already in use.

500

Internal Server Error

Error message example:

  • Unable to set password for user.

  • User update failed unexpectedly

Related Articles

Trending Articles

Don't see what you're looking for?