Authorization
Authorization
RequiredBearer <token>< Project ID >:< Management Key > as bearer
In: header
Request Body
application/json
Requiredusers
array<object>invite
booleansendMail
booleansendSMS
booleaninviteUrl
stringtemplateOptions
objectcurl -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
}
},
"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?