SCIM API for User Creation
2 months ago

SCIM API for User Creation

Use the SCIM API for creating a user in the Unified Directory.

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
POST

<Base URI>/Users

application/scim+json

User details201, 400, 401, 409, 500

Example Request Data

POST <Base URI>/Users

Authorization: Bearer 29da0602f6db1ed033aa91d644ce4d70bdf3ab58

Content-Type: application/scim+json

Example Request Body

The following examples display a user creation request.

User Creation - Minimal User Representation

{
    "userName": "User One",

    "emails": [{
            "type": "work",
            "value": "user.one@example.com"
        }
    ]
}

User Creation - Full User Representation

{
    "userName": "clouduser5",
    "displayName": "clouduser5-dn",
    "nickName": "clouduser5-nn",
    "password": "SamplePassword@123",
    "title": "clouduser5-title",
    "active": true,
    "emails": [{
            "type": "work",
            "value": "clouduser5@example.com",
            "primary": true
        }, {
            "type": "home",
            "value": "clouduser5home@example.com",
            "primary": false
        }, {
            "type": "other",
            "value": "clouduser5other@example.com",
            "primary": false
        }
    ],
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
    ],
    "name": {
        "givenName": "clouduser5-givenName",
        "familyName": "clouduser5-familyName",
        "formatted": "clouduser5-formatted",
    },
    "phoneNumbers": [{
            "type": "work",
            "value": "+31 65 7777777",
            "primary": true
        }, {
            "type": "mobile",
            "value": "+31 65 8888888",
            "primary": false
        }, {
            "type": "home",
            "value": "+31 65 9999999",
            "primary": false
        }, {
            "type": "pager",
            "value": "+31 65 999999",
            "primary": false
        }, {
            "type": "fax",
            "value": "+31 65 999999",
            "primary": false
        }, {
            "type": "other",
            "value": "+31 65 999999",
            "primary": false
        }
    ],
    "addresses": [{
            "type": "work",
            "formatted": "changedformatted",
            "streetAddress": "changedworkStreetAddress",
            "locality": "changedlocality",
            "region": "changedregion",
            "postalCode": "changedpostalCode",
            "country": "changedcountry",
            "primary": true
        }, {
            "type": "home",
            "formatted": "changedformatted",
            "streetAddress": "changedworkStreetAddress",
            "locality": "changedlocality",
            "region": "changedregion",
            "postalCode": "changedpostalCode",
            "country": "changedcountry",
            "primary": false
        }, {
            "type": "other",
            "formatted": "formatted",
            "streetAddress": "changedWorkStreetAddress",
            "locality": "locality",
            "region": "region",
            "postalCode": "postalCode",
            "country": "country",
            "primary": false
        }
    ],
    "locale": "EN_US",
    "preferredLanguage": "English",
    "userType": "Employee",
}

Request Body Parameters

See the SCIM Attributes section for the request parameters.

Response

The API returns the user details.

Example Response

User Creation - Minimal User Representation

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "400e299e-3b99-4cb7-9f17-c315290ffeb9",
    "meta": {
        "resourceType": "User",
        "created": "2022-12-17T09:03:39-05:00",
        "lastModified": "2022-12-17T09:03:39-05:00",
        "location": "<Base URI>/Users/400e299e-3b99-4cb7-9f17-c315290ffeb9"
    },
    "userName": "User One",
    "active": true,
    "emails": [{
            "type": "work",
            "value": "user.one@example.com"
        }
    ]
}

User Creation - User Representation

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "15b2c192-052f-913c-7bcb-d84cb8101fba",
    "meta": {
        "resourceType": "User",
        "created": "2023-01-20T06:13:46.663Z",
        "lastModified": "2023-01-20T06:13:46.663Z",
        "location": "<Base URI>/Users/d4dd1651-fd28-b8b3-b485-8912862b0033"
    },
    "userName": "clouduser5",
    "name": {
        "formatted": "clouduser5-formatted",
        "familyName": "clouduser5-familyName",
        "givenName": "clouduser5-givenName"
    },
    "displayName": "clouduser5-dn",
    "nickName": "clouduser5-nn",
    "title": "clouduser5-title",
    "userType": "Employee",
    "preferredLanguage": "English",
    "locale": "clouduser5-locale",
    "active": true,
    "emails": [{
            "value": "clouduser5@example.com",
            "type": "work",
            "primary": true
        }, {
            "value": "clouduser5home@example.com",
            "type": "home",
            "primary": false
        }, {
            "value": "clouduser5other@example.com",
            "type": "other",
            "primary": false
        }
    ],
    "phoneNumbers": [{
            "value": "+31 65 7777777",
            "type": "mobile",
            "primary": false
        }, {
            "value": "+31 65 8888888",
            "type": "work",
            "primary": true
        }, {
            "value": "+31 65 9999999",
            "type": "home",
            "primary": false
        }, {
            "value": "+31 65 9999999",
            "type": "fax",
            "primary": false
        }, {
            "value": "+31 65 9999999",
            "type": "pager",
            "primary": false
        }, {
            "value": "+31 65 9999999",
            "type": "other",
            "primary": false
        }
    ],
    "addresses": [{
            "formatted": "changedformatted",
            "streetAddress": "changedworkStreetAddress",
            "locality": "changedlocality",
            "region": "changedregion",
            "postalCode": "changedpostalCode",
            "country": "changedcountry",
            "type": "home",
            "primary": false
        }, {
            "formatted": "changedformatted",
            "streetAddress": "changedworkStreetAddress",
            "locality": "changedlocality",
            "region": "changedregion",
            "postalCode": "changedpostalCode",
            "country": "changedcountry",
            "type": "work",
            "primary": true
        }, {
            "formatted": "formatted",
            "streetAddress": "changedWorkStreetAddress",
            "locality": "locality",
            "region": "region",
            "postalCode": "postalCode",
            "country": "country",
            "type": "other",
            "primary": false
        }
    ]
}

Response Property Descriptions

See SCIM Attributes.

Response Codes

The following table shows response codes for this API.

CodeDescription
201Created
400

Bad Request

Error message examples:

  • Could not provision user as userName exceeded max size.

  • Attribute userName is required and must have a value.

  • Could not provision user as password policy violated.

  • Could not provision user as invalid email id is specified.

  • Attribute email is required and must have a value.

  • Could not provision user as user is inactive in request.

  • User Provisioning failed with: {ERROR_DESC}

  • User Provisioning 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 Provisioning 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 Provisioning failed.

{

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

}

  • User Provisioning 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 Provisioning failed.

{

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

}

409

  • Could not provision user as userName already exists.

  • Could not provision user as specified email id is already in use.

500Unable to set password for user.
Don't see what you're looking for?