Create User | API Reference | Descope Documentation

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired

loginIdstring

emailstring

phonestring

verifiedEmailboolean

verifiedPhoneboolean

namestring

roleNamesarray<string>

userTenantsarray<object>

inviteboolean

testboolean

Default: false

customAttributesobject

custom attributes of users

picturestring

sendMailboolean

sendSMSboolean

additionalIdentifiersarray<string>

inviteUrlstring

passwordstring

hashedPasswordobject

givenNamestring

middleNamestring

familyNamestring

ssoAppIdsarray<string>

templateOptionsobject

curl -X POST "https://api.descope.com/v1/mgmt/user/create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -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": {
      "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"
      },
      "md5": {
        "hash": "string"
      },
      "bach": {
        "hash": "string",
        "key": "string"
      },
      "argon2": {
        "hash": "string",
        "salt": "string",
        "iterations": 0,
        "memory": 0,
        "threads": 0
      }
    },
    "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,
    "SCIM": true
  }
}

Was this helpful?

Authorization

Request Body

Response

TypeScript