SCIM Endpoints

POST /api/v3/accounts/{account_id}/scim/v2/Users

Changed on

Create a user via SCIM

Request

  • Base URL
    https://cloud.getdbt.com
  • Auth
    HTTP bearer

Path parameters

account_idinteger required

Request body

schemasstring[] required

The user schemas supported by the SCIM provider

externalIdstring

The external ID of the user (user's scim id)

userNamestring required

The username for the user which is their email address

activeboolean required

Whether the user is active

Example request

{
  "externalId": "12uhdfs0",
  "emails": [
    {
      "value": "john.smith@example.com",
      "primary": true
    }
  ]
}

Response

extraobject
error_codeinteger

Example response

{
  "data": {
    "externalId": "12uhdfs0",
    "emails": [
      {
        "value": "john.smith@example.com",
        "primary": "True"
      }
    ],
    "groups": [
      {
        "value": "1234",
        "externalId": "group-1234",
        "display": "Example Group"
      }
    ]
  }
}

Changes

    • info

      the request property default value {"licenseType":"developer"} was removed (media type: application/scim+json)

    • info

      the request property default value {"licenseType":"developer"} was removed (media type: application/json)

    • breaking

      for the path request parameter account_id, the format changed from no format to int64