Update Account: PATCH

Update a specific Managed Account in an organization.

Method

PATCH

URL

/Users/:id

Example: /Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu

URL parameters

Parameter name	Type	Description
id	String	Account ID (string that uniquely identifies the account) Included in the “Get account” response as Resources.id. Not displayed on the Nulab product screen.

Request example

Request body

{
    "schemas": [
        "urn:ietf:params:scim:api:messages:2.0:PatchOp"
    ],
    "Operations": [
            {
                "op": "Replace",
                "path": "userName",
                "value": "example@nulab.com"
            },
            {
                "op": "Replace",
                "path": "displayName",
                "value": "Example Nulab"
            },
            {
                "op": "Replace",
                "path": "preferredLanguage",
                "value": "en"
            },
            {
                "op": "Replace",
                "path": "locale",
                "value": "en"
            },
            {
                "op": "Replace",
                "path": "timezone",
                "value": "Asia/Tokyo"
            },
            {
                "op": "Replace",
                "path": "active",
                "value": false
            },
            {
                "op": "Replace",
                "path": "roles",
                "value": [{ "value" : "ADMIN" }]
            }
   ]
}

Request description

Parameter name	Type	Description
schemas (Required)	String	Fixed as “urn:ietf:params:scim:api:messages:2.0:PatchOp”
Operations
op (Required)	String	Fixed as “Replace”
path (Required)	String	Attribute name to change
value (Required)	String	Value

Attributes for path

Parameter name	Type	Description
userName	String	Verified domain email address (uniquely identifies the account)
displayName	String	Username
preferredLanguage	String	Language
locale	String	Language (preferredLanguage takes precedence)
timezone	String	Time zone
active	Boolean	Status of the account (true = active, false = inactive)
roles	String	ADMIN = Administrator USER = Member GUEST = Guest If more than one is specified, the value of the role whose primary is true is registered.

Values other than those listed above are ignored during registration.

Response example

Status line / Response header

HTTP/1.1	200 OK
Content-Type: application/scim+json;charset=UTF-8

Response body

{
    "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
    ],
    "id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
    "meta": {
        "resourceType": "User",
        "created": "2024-03-22T04:42:01Z",
        "lastModified": "2024-03-22T05:58:30Z",
        "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
    },
    "userName": "example@nulab.com",
    "displayName": "Example Nulab",
    "preferredLanguage": "en",
    "locale": "en",
    "timezone": "Asia/Tokyo",
    "active": false,
    "roles": [
        {
            "value": "ADMIN",
            "primary": true
        }
    ]
}

Response description

Parameter name	Type	Description
id	String	Account ID (string that uniquely identifies the account)
userName	String	Email address (uniquely identifies the account)
displayName	String	Username
preferredLanguage	String	Language (same value as locale)
locale	String	Language (same value as preferredLanguage)
timezone	String	Time zone
active	Boolean	Status of the account (true = active, false = inactive)
roles.[0].value	String	ADMIN = Administrator USER = Member GUEST = Guest