API Reference/Management/Users
POST
/v1/mgmt/user/create/batch

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
usersarray<object>
inviteboolean
sendMailboolean
sendSMSboolean
inviteUrlstring
templateOptionsobject
curl -X POST "https://api.descope.com/v1/mgmt/user/create/batch" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "users": [
      {
        "loginId": "string",
        "email": "string",
        "phone": "string",
        "verifiedEmail": true,
        "verifiedPhone": true,
        "name": "string",
        "roleNames": [
          "string"
        ],
        "userTenants": [
          {
            "tenantId": "string",
            "roleNames": [
              "string"
            ]
          }
        ],
        "test": false,
        "picture": "string",
        "customAttributes": {},
        "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
          },
          "sha": {
            "hash": "string",
            "type": "string"
          }
        },
        "additionalIdentifiers": [
          "string"
        ],
        "givenName": "string",
        "middleName": "string",
        "familyName": "string",
        "ssoAppIds": [
          "string"
        ],
        "seed": "string"
      }
    ],
    "invite": true,
    "sendMail": true,
    "sendSMS": true,
    "inviteUrl": "string",
    "templateOptions": {
      "property1": "string",
      "property2": "string"
    }
  }'

OK

{
  "createdUsers": [
    {
      "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
    }
  ],
  "failedUsers": [
    {
      "failure": "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
      }
    }
  ],
  "additionalErrors": {
    "property1": "string",
    "property2": "string"
  }
}

Was this helpful?

Create User POST

### 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. ### See also - See [Manage User](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

Patch User PATCH

### Patch a user's details, using a valid management key. This API endpoint will patch a user's details of a user utilizing a valid management key. ### See also - See [Manage Users](/manage/users) for further details on managing users. - See [The User Object](/api/overview#the-user-object) for further details on the user object. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`