Replace user

put

https://miro.com/api/v1/scim/Users/{id}

Updates an existing user resource. This is the easiest way to replace user information.

If the user is deactivated,
userName, userType, and roles.value cannot be updated.
emails.value, emails.display, emails.primary get ignored and do not return any error.

Note: If the user is not a member in the organization, they cannot be updated. Additionally, users with guest role in the organization cannot be updated.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

User ID. A server-assigned, unique identifier for this user.

Body Params

Payload to update user information.

schemas

array of strings

Identifies which schema(s) this resource uses. In this case it is the SCIM core User schema.

schemas

Allowed:

string

A server-assigned, unique identifier for this user.

meta

object

Metadata about the resource.

userName

string

The unique username/login identifier. An email address in this case.

name

object

Structured object for the person’s name. This includes the family name (last name), and given name (first name).

displayName

string

A human-readable name for the user, typically the full name.

userType

string

Free-form string to indicate the user license type in the organization.

active

boolean

Indicates whether the user is active or deactivated in the organization.

emails

array of objects

An array of email addresses, each an object with a value, display and primary flag.

emails

photos

array of objects

An array for profile pictures, contains type.

photos

groups

array of objects

An array of groups (teams) the user belongs to in the organization. Contains id and display name of the team.

groups

roles

array of objects

An array of roles assigned to the user in the organization. Contains role type, value, display and primary flag.

roles

preferredLanguage

string

Specifies the users preferred language.

Example: en_US for English.

urn:ietf:params:scim:schemas:extension:enterprise:2.0:User

object

Enterprise User extension schema.

Headers

string

enum

Defaults to application/scim+json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/scim+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

Bearer

Loading…

Response

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

application/scim+json

application/json

200Successful Operation

401Invalid authentication credentials

403Invalid access

404Not found Conditions: - If the user is not a member in the organization, the user cannot be updated.

409Conflict Conditions: - If the userName is updated to an email that already exists in the organization, the user cannot be updated. The userName cannot be updated for the user if the organization does not owns the old and the new domain of the email address

429Too many requests.

500Internal Server Error