Create tenant assumed role Users

post

https://tenants-gateway-api-sbx.sidedrawersbx.com/api/v1/tenants/tenant/tenant-id/{tenantId}/users

Creates assumed role Users for a Tenant.

Path Params

tenantId

string

required

Tenant identifier.

Body Params

federationId

string

This is only applicable for enterprise implementations. The federationId identifies the institution. This is optional in this case; just for a scenario in which you need to create a User that will be federated later by an enterprise SSO connection.

firstName

string

required

Account first name.

lastName

string

required

Account last name.

businessName

string

Business name.

countryOfResidence

string

Country of residence.

profilePhoto

string

URL of the profile photo.

dateOfBirth

date-time

Date of birth in DD/MM/YYYY format.

maritalStatus

string

enum

Marital status.

Allowed:

primaryResidence

object

Account User's primary residence address.

gender

string

enum

Account User's gender.

Allowed:

emails

array of objects

required

Account emails.

emails*

phones

array of objects

required

Account phone number(s).

phones*

agreements

array of objects

required

An Agreements object. These are agreements that must be accepted when a SideDrawer Account is created. Newer versions may also be sent out when required. There are three agreement types: terms of service (tos), privacy policies (privacy_policies), and anti-spam (anti_spam).

agreements*

identityProvider

string

enum

Identity provider used. Default: Auth0.

Allowed:

region

string

Region.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201The Account has been successfully created.