Rebilly API Docs

Create a user

Creates a user.

SecuritySecretApiKey or JWT

Request

Request Body schema: application/json

User resource.

email required	string <email> <= 100 characters Email address of the user.
firstName required	string User's first name.
lastName required	string User's last name.
businessPhone	string User's business phone number.
mobilePhone	string User's mobile phone number.
password	string <password> User's password. If this value is not provided, a password reset email is sent.
permissions	Array of strings <operationId> Permissions that the user has within organizations. Use the wildcard character `*` for full access.
totpRequired	boolean Specifies if two-factor authentification is enabled for the user.
totpSecret	string User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled..
totpUrl	string <url> QR-code link that redirects the user to the authentification application, if TOTP is enabled.
country	string User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.
preferences	object User preferences, such as: timezone, language, and more. This is an object with custom properties.
roleIds	Array of strings Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.
allowedIps	Array of strings or null <ip> (AllowedIps) List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to `null`.

Responses

201

User created.

Response Headers
Location	string <uri> Location of the related resource. Example: "https://api.rebilly.com/example"

Response Schema: application/json

required

string <email> <= 100 characters

Email address of the user.

firstName

required

string

User's first name.

lastName

required

string

User's last name.

string <= 50 characters

ID of the user.

businessPhone

string

User's business phone number.

mobilePhone

string

User's mobile phone number.

password

string <password>

User's password. If this value is not provided, a password reset email is sent.

permissions

Array of strings <operationId>

Permissions that the user has within organizations. Use the wildcard character * for full access.

computedPermissions

Array of strings <operationId>

All user permissions and roles. Use these permissions to emulate the user.

createdTime

string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime

string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

loginTime

string <date-time>

Date and time when the user last logged in.

reportingCurrency

string

User's currency code in ISO 4217 format. This value is used for reports.

availableCurrencies

Array of strings

Array of reporting currencies that are enabled for the merchant.

totpRequired

boolean

Specifies if two-factor authentification is enabled for the user.

totpSecret

string

User's Time-based One-Time Password (TOTP) key for the authentification application, if TOTP is enabled..

totpUrl

string <url>

QR-code link that redirects the user to the authentification application, if TOTP is enabled.

status

string

Status of the user's account.

Enum: "active" "inactive" "pending-confirmation"

country

string

User's country of residence in ISO 3166 alpha-2 country code. For examples, see ISO.org.

preferences

object

User preferences, such as: timezone, language, and more. This is an object with custom properties.

roleIds

Array of strings

Role IDs associated with the user. Role IDs specify the roles that the user performs within the organization. For example, the user may be an organization admin.

allowedIps

Array of strings or null <ip> (AllowedIps)

List of IP addresses that are permitted access. Private subnets are prohibited. To remove restrictions, set this value to null.

Array of objects (SelfLink)

Related links.

Array

href	string Link URL.
rel	string Type of link. Value: "self"

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/users

Request samples

application/json

{"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"businessPhone": "string",
"mobilePhone": "string",
"password": "pa$$word",
"permissions": ["PostFile",
"StorefrontGetAccount",
"StorefrontGetWebsite",
"StorefrontGetKycDocumentCollection",
"StorefrontGetKycDocument",
"StorefrontPostKycDocument"
],
"totpRequired": true,
"totpSecret": "string",
"totpUrl": "string",
"country": "string",
"preferences": { },
"roleIds": ["string"
],
"allowedIps": ["153.12.32.33",
"201.54.122.0/24",
"76.*.*.*",
"2001:0db8:abcd:0012:0000:0000:0000:ffff",
"2001:db8:abcd:12::0/64"
]
}

Response samples

application/json

{"id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
"email": "user@example.com",
"firstName": "string",
"lastName": "string",
"businessPhone": "string",
"mobilePhone": "string",
"password": "pa$$word",
"permissions": ["PostFile",
"StorefrontGetAccount",
"StorefrontGetWebsite",
"StorefrontGetKycDocumentCollection",
"StorefrontGetKycDocument",
"StorefrontPostKycDocument"
],
"computedPermissions": ["PostFile",
"StorefrontGetAccount",
"StorefrontGetWebsite",
"StorefrontGetKycDocumentCollection",
"StorefrontGetKycDocument",
"StorefrontPostKycDocument"
],
"createdTime": "2019-08-24T14:15:22Z",
"updatedTime": "2019-08-24T14:15:22Z",
"loginTime": "2019-08-24T14:15:22Z",
"reportingCurrency": "string",
"availableCurrencies": ["string"
],
"totpRequired": true,
"totpSecret": "string",
"totpUrl": "string",
"status": "active",
"country": "string",
"preferences": { },
"roleIds": ["string"
],
"allowedIps": ["153.12.32.33",
"201.54.122.0/24",
"76.*.*.*",
"2001:0db8:abcd:0012:0000:0000:0000:ffff",
"2001:db8:abcd:12::0/64"
],
"_links": [{"href": "string",
"rel": "self"
}
]
}

➔ Next to Retrieve a user