Create User | API Reference | Descope Documentation

POST

/v1/mgmt/user/create

Create a new user, using a valid management key.

This API endpoint will create a new user utilizing a valid management key.

This API endpoint allows you to configure all aspects of a user:

loginId
email
phone
verified settings (phone, email) - one must be set to true
displayName
roleNames
Tenant configurations - which tenantIds, which roleNames. The userTenants can include multiple items Ex:

"userTenants": [
{
  "tenantId": "T2IMjmRfYTQHlbaastz3im59ERS3",
  "roleNames": [
    "Test"
  ]
},
{
  "tenantId": "T2Igau6dX1R6SkomtFCdBLrc3r67",
  "roleNames": [
    "Test"
  ]
}

Additionally, you can create a user with multiple login IDs by passing an array of loginIds in string format within the additionalIdentifiers key.

Next Steps

Once the user is created, the user can then login utilizing any sign-in api supported. This will then switch the user from invited to active.

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

`loginId`string

`email`string

`phone`string

`verifiedEmail`boolean

`verifiedPhone`boolean

`name`string

`roleNames`array<string>

`userTenants`array<object>

`invite`boolean

`test`boolean

Default: false

`customAttributes`object

custom attributes of users

`picture`string

`sendMail`boolean

`sendSMS`boolean

`additionalIdentifiers`array<string>

`inviteUrl`string

`password`string

`hashedPassword`object

`givenName`string

`middleName`string

`familyName`string

`ssoAppIds`array<string>

`templateOptions`object

Status code	Description
`200`	OK

curl -X POST "https://api.descope.com/v1/mgmt/user/create" \
  -d '{
  "loginId": "string",
  "email": "string",
  "phone": "string",
  "verifiedEmail": true,
  "verifiedPhone": true,
  "name": "string",
  "roleNames": [
    "string"
  ],
  "userTenants": [
    {
      "tenantId": "string",
      "roleNames": [
        "string"
      ]
    }
  ],
  "invite": true,
  "test": false,
  "customAttributes": {},
  "picture": "string",
  "sendMail": true,
  "sendSMS": true,
  "additionalIdentifiers": [
    "string"
  ],
  "inviteUrl": "string",
  "password": "string",
  "hashedPassword": {
    "algorithm": "string",
    "hash": "string",
    "salt": "string",
    "iterations": 0,
    "bcrypt": {
      "hash": "string"
    },
    "django": {
      "hash": "string"
    },
    "firebase": {
      "hash": "string",
      "salt": "string",
      "saltSeparator": "string",
      "signerKey": "string",
      "memory": 0,
      "rounds": 0
    },
    "pbkdf2": {
      "hash": "string",
      "salt": "string",
      "iterations": 0,
      "type": "string"
    },
    "phpass": {
      "hash": "string",
      "salt": "string",
      "iterations": 0,
      "type": "string"
    }
  },
  "givenName": "string",
  "middleName": "string",
  "familyName": "string",
  "ssoAppIds": [
    "string"
  ],
  "templateOptions": {
    "property1": "string",
    "property2": "string"
  }
}'

{
  "user": {
    "loginIds": [
      "string"
    ],
    "userId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "verifiedEmail": true,
    "verifiedPhone": true,
    "roleNames": [
      "string"
    ],
    "userTenants": [
      {
        "tenantId": "string",
        "roleNames": [
          "string"
        ],
        "tenantName": "string"
      }
    ],
    "status": "string",
    "externalIds": [
      "string"
    ],
    "picture": "string",
    "test": false,
    "customAttributes": {},
    "createdTime": 0,
    "TOTP": false,
    "SAML": false,
    "OAuth": {
      "property1": false,
      "property2": false
    },
    "webauthn": true,
    "password": true,
    "ssoAppIds": [
      "string"
    ],
    "givenName": "string",
    "middleName": "string",
    "familyName": "string",
    "editable": true
  }
}

Was this helpful?

Create a new user, using a valid management key.

Next Steps

See also

Endpoint Authentication

Try it

Authorization

`Authorization`
Required
Bearer <token>

Request Body

`loginId`string

`email`string

`phone`string

`verifiedEmail`boolean

`verifiedPhone`boolean

`name`string

`roleNames`array<string>

`userTenants`array<object>

`invite`boolean

`test`boolean

`customAttributes`object

`picture`string

`sendMail`boolean

`sendSMS`boolean

`additionalIdentifiers`array<string>

`inviteUrl`string

`password`string

`hashedPassword`object

`givenName`string

`middleName`string

`familyName`string

`ssoAppIds`array<string>

`templateOptions`object

Create a new user, using a valid management key.

Next Steps

See also

Endpoint Authentication

Try it

Authorization

AuthorizationRequiredBearer <token>

Request Body

loginIdstring

emailstring

phonestring

verifiedEmailboolean

verifiedPhoneboolean

namestring

roleNamesarray<string>

userTenantsarray<object>

Object 1

inviteboolean

testboolean

customAttributesobject

customAttributes

picturestring

sendMailboolean

sendSMSboolean

additionalIdentifiersarray<string>

inviteUrlstring

passwordstring

hashedPasswordobject

hashedPassword

givenNamestring

middleNamestring

familyNamestring

ssoAppIdsarray<string>

templateOptionsobject

templateOptions

Response

Typescript

`Authorization`
Required
Bearer <token>

`loginId`string

`email`string

`phone`string

`verifiedEmail`boolean

`verifiedPhone`boolean

`name`string

`roleNames`array<string>

`userTenants`array<object>

`invite`boolean

`test`boolean

`customAttributes`object

`picture`string

`sendMail`boolean

`sendSMS`boolean

`additionalIdentifiers`array<string>

`inviteUrl`string

`password`string

`hashedPassword`object

`givenName`string

`middleName`string

`familyName`string

`ssoAppIds`array<string>

`templateOptions`object