enterprise-admin

Provision a SCIM enterprise user

Creates an external identity for a new SCIM enterprise user.

SCIM is responsible for user provisioning, not authentication. The actual user authentication is handled by SAML. However, with SCIM enabled, users must first be provisioned via SCIM before they can sign in through SAML.

post/scim/v2/enterprises/{enterprise}/Users

Request

  • Base URL: https://api.github.com
  • URL: https://api.github.com/scim/v2/enterprises/{enterprise}/Users
  • Auth: none declared

Path parameters

enterprisestring required

The slug version of the enterprise name.

Request body

schemasstring[] required

The URIs that are used to indicate the namespaces of the SCIM schemas.

externalIdstring required

A unique identifier for the resource as defined by the provisioning client.

activeboolean required

Whether the user active in the IdP.

userNamestring required

The username for the user.

displayNamestring required

A human-readable name for the user.

Example request

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "externalId": "E012345",
  "active": true,
  "userName": "E012345",
  "name": {
    "formatted": "Ms. Mona Lisa Octocat",
    "familyName": "Octocat",
    "givenName": "Mona",
    "middleName": "Lisa"
  },
  "displayName": "Mona Lisa",
  "emails": [
    {
      "value": "mlisa@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "roles": [
    {
      "value": "user"
    }
  ]
}

Response

User has been created

Changes

No recorded changes to this operation across all 83 revisions of this API.