Upsert a user

Request

Creates or updates (upserts) a user with a specified ID.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required
ID of the resource.
Bodyapplication/jsonrequired
User resource.
emailstring, (email), <= 80 charactersrequired
Email address of the user.
firstNamestring, [ 1 .. 45 ] charactersrequired
User's first name.
lastNamestring, [ 1 .. 45 ] charactersrequired
User's last name.
businessPhonestring or null, [ 1 .. 20 ] characters
User's business phone number.
mobilePhonestring or null, [ 1 .. 20 ] characters
User's mobile phone number.
permissionsArray of strings, (operationId)(AclPermissions)
Permissions that the user has within organizations. Use the wildcard character `*` for full access.
Example:
[ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ]
countrystring

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

preferencesobject or null
User preferences, such as: timezone, language, and more. This is an object with custom properties.
roleIdsArray 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.
allowedIpsArray 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.

Example:
[ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ]
curl -i -X PUT \
  'https://www.rebilly.com/_mock/catalog/all/users/{id}' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "email": "user@example.com",
    "firstName": "string",
    "lastName": "string",
    "businessPhone": "string",
    "mobilePhone": "string",
    "permissions": [
      "PostFile",
      "StorefrontGetAccount",
      "StorefrontGetWebsite",
      "StorefrontGetKycDocument",
      "StorefrontPostKycDocument"
    ],
    "country": "string",
    "preferences": {},
    "roleIds": [
      "string"
    ],
    "allowedIps": [
      "153.12.32.33",
      "201.54.122.0/24",
      "2001:0db8:abcd:0012:0000:0000:0000:ffff",
      "2001:db8:abcd:12::0/64"
    ]
  }'

Responses

User updated.
Headers
Rate-Limit-Limitinteger

Maximum number of requests available at one time for this rate limit. For more information, see Rate limits.

Example:500
Rate-Limit-Remaininginteger

Number of requests still available for this rate limit. For more information, see Rate limits.

Example:499
Bodyapplication/json
idstring, <= 50 charactersread-only
ID of the user.
Example:"usr_0YVCEENYJ3D7Q9EN6BN16HA0G4"
emailstring, (email), <= 80 charactersrequired
Email address of the user.
firstNamestring, [ 1 .. 45 ] charactersrequired
User's first name.
lastNamestring, [ 1 .. 45 ] charactersrequired
User's last name.
businessPhonestring or null, [ 1 .. 20 ] characters
User's business phone number.
mobilePhonestring or null, [ 1 .. 20 ] characters
User's mobile phone number.
permissionsArray of strings, (operationId)(AclPermissions)
Permissions that the user has within organizations. Use the wildcard character `*` for full access.
Example:
[ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ]
computedPermissionsArray of strings, (operationId)(AclPermissions)read-only
All user permissions and roles. Use these permissions to emulate the user.
Example:
[ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ]
createdTimestring, (date-time)(CreatedTime)read-only
Date and time when the resource is created. This value is set automatically when the resource is created.
updatedTimestring, (date-time)(UpdatedTime)read-only
Date and time when the resource is updated. This value is set automatically when the resource is updated.
loginTimestring or null, (date-time)read-only
Date and time when the user last logged in.
reportingCurrencystringread-only
User's currency code in ISO 4217 format. This value is used for reports.
availableCurrenciesArray of stringsread-only
Array of reporting currencies that are enabled for the merchant.
statusstringread-only
Status of the user's account.
Enum:"active""inactive""pending-confirmation"
countrystring

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

preferencesobject or null
User preferences, such as: timezone, language, and more. This is an object with custom properties.
roleIdsArray 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.
allowedIpsArray 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.

Example:
[ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ]
computedAllowedIpsArray of strings or null, (ip)read-only

IP addresses specified in allowedIps for the user, the roles assigned to the user, and any roles included in those roles. This value is null if no allowed IP addresses are configured for any of them. This value is also null when a Rebilly admin retrieves their own user.

mfaEnabledboolean or nullread-only

Specifies if the user has multi-factor authentication (MFA) set up. This field is included in Retrieve a user responses for users in the current organization, and in Retrieve a list of users responses only when the organization requires MFA. This field is omitted for Rebilly staff. This value is null when this information is temporarily unavailable.

Response
{ "id": "usr_0YVCEENYJ3D7Q9EN6BN16HA0G4", "email": "user@example.com", "firstName": "string", "lastName": "string", "businessPhone": "string", "mobilePhone": "string", "permissions": [ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ], "computedPermissions": [ "PostFile", "StorefrontGetAccount", "StorefrontGetWebsite", "StorefrontGetKycDocument", "StorefrontPostKycDocument" ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z", "loginTime": "2019-08-24T14:15:22Z", "reportingCurrency": "string", "availableCurrencies": [ "string" ], "status": "active", "country": "string", "preferences": {}, "roleIds": [ "string" ], "allowedIps": [ "153.12.32.33", "201.54.122.0/24", "2001:0db8:abcd:0012:0000:0000:0000:ffff", "2001:db8:abcd:12::0/64" ], "computedAllowedIps": [ "string" ], "mfaEnabled": true, "_links": [ { … } ] }