This API endpoint will batch create new users utilizing a valid management key.
This API endpoint allows you to configure all aspects of a user:
"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.
You can also decide whether to invite the users, configure the inviteUrl, and whether to send invites via email or SMS.
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.
Use authorization bearer header with the following format:
Authorization: Bearer <ProjectId:ManagementKey>
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
}
], - "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
}
}
]
}