Provision and invite a SCIM user

POST

/scim/v2/organizations/{org}/Users

Provision organization membership for a user, and send an activation email to the email address.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.github.com/scim/v2/organizations//Users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "active": true,
    "displayName": "Jon Doe",
    "emails": [
        {
            "primary": true,
            "value": "someone@example.com"
        },
        {
            "primary": false,
            "value": "another@example.com"
        }
    ],
    "externalId": "string",
    "groups": [
        "string"
    ],
    "name": {
        "familyName": "User",
        "givenName": "Jane"
    },
    "schemas": [
        "string"
    ],
    "userName": "someone@example.com"
}'

Response Example

201 - Example 1

{}

Request

Path Params

org

string

required

Body Params application/json

active

boolean

optional

displayName

string

optional

The name of the user, suitable for display to end-users

Example:

Jon Doe

emails

array [object {3}]

required

user emails

>= 1 items

Example:

[{"primary":true,"value":"someone@example.com"},{"primary":false,"value":"another@example.com"}]

primary

boolean

optional

type

string

optional

value

string

required

externalId

string

optional

groups

array[string]

optional

name

object

required

Example:

{"familyName":"User","givenName":"Jane"}

familyName

string

required

formatted

string

optional

givenName

string

required

schemas

array[string]

optional

userName

string

required

Configured by the admin. Could be an email, login, or username

Example:

someone@example.com

Examples

Responses

🟢201response

application/json

Body

object {0}

🔵304304

🟠400400

🟠403403

🟠404404

🟠409409

🔴500500

Modified at 2022-09-10 00:54:32

List SCIM provisioned identities

Delete a SCIM user from an organization