Get Account

Get information on a specific account, including non-Managed Accounts, in an organization.

Method

GET

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.

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",
    "externalId": "AHorowitz",
    "meta": {
        "resourceType": "User",
        "created": "2024-02-13T05:03:49Z",
        "lastModified": "2024-02-27T08:01:23Z",
        "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
    },
    "userName": "example@nulab.com",
    "displayName": "AHorowitz",
    "preferredLanguage": "en",
    "locale": "en",
    "timezone": "Asia/Tokyo",
    "active": true,
    "roles": [
        {
            "value": "ADMIN",
            "primary": true
        }
    ]
}

Response description

Parameter name	Type	Description
id	String	Account ID (string that uniquely identifies the account)
externalId	String	External ID to identify accounts assigned by IdP
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