Skip to main content
PUT
Error

Authorizations

Authorization
string
header
required

Prefix the value with "ApiKey" to indicate the custom authorization type

Path Parameters

id
string
required

Query Parameters

attributes
string

Comma-separated SCIM defined attributes to be returned. Required attributes are always returned

excludedAttributes
string

Comma-separated SCIM defined attributes to be excluded. Required attributes cannot be excluded

Body

application/scim+json
addresses
object[]
required

A physical mailing address for this user. If multiple addresses are present, the element that will be used as the user's Firstbase address will be selected by the following precedence: type home marked as primary, the first home address, the primary address, otherwise the first provided address.

userName
string
required

The userName must match the primary email address.

Example:

"jenny.smith@example.com"

emails
object[]
required

Email addresses for the user. If multiple addresses are present, the primary will be used, otherwise the first element will be the user's Firstbase primary email AND userName.

name
object
required

The components of the user's name.

urn:ietf:params:scim:schemas:extension:firstbase:1.0:User
object
required

Define attributes of the User's on-boarding, including their initial package ID and start date.

schemas
string[]
required

The schemas defining the attributes of the resources.

Example:
phoneNumbers
object[]

Phone numbers for the user. The value SHOULD be specified according to the format defined in [RFC3966], e.g., 'tel:+1-201-555-0123' If multiple phone numbers are present, the primary otherwise the first element will be the user's Firstbase phone number.

Response

User has been updated

id
string<uuid>
required
read-only
addresses
object[]
required

A physical mailing address for this user. If multiple addresses are present, the element that will be used as the user's Firstbase address will be selected by the following precedence: type home marked as primary, the first home address, the primary address, otherwise the first provided address.

userName
string
required

The userName must match the primary email address.

Example:

"jenny.smith@example.com"

emails
object[]
required

Email addresses for the user. If multiple addresses are present, the primary will be used, otherwise the first element will be the user's Firstbase primary email AND userName.

name
object
required

The components of the user's name.

urn:ietf:params:scim:schemas:extension:firstbase:1.0:User
object
required

Define attributes of the User's on-boarding, including their initial package ID and start date.

schemas
string[]
required

The schemas defining the attributes of the resources.

Example:
phoneNumbers
object[]

Phone numbers for the user. The value SHOULD be specified according to the format defined in [RFC3966], e.g., 'tel:+1-201-555-0123' If multiple phone numbers are present, the primary otherwise the first element will be the user's Firstbase phone number.