Get Account List

Get a list of all accounts, including non-Managed Accounts, in an organization.

Method

GET

URL

/Users

/Users?filter=userName+eq+"MAIL_ADDRESS"

Example:
/Users?filter=userName+eq+%22example%40nulab.com%22

Query parameters

Parameter name	Type	Description
filter	String	Attribute name followed by attribute operator and value (e.g., userName+eq+%22example%40nulab.com%22)
startIndex	Number	Index of the first account in the result list to be retrieved (assumed to be 1 if not specified)
count	Number	Maximum number of result lists to be retrieved(assumed to be 100 if not specified)

Supported attribute names

Attribute name	Type	Example of use
userName	String	Email address

Supported SCIM filters

Filter type	Description
eq	Equal

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:api:messages:2.0:ListResponse"
    ],
    "totalResults": 2,
    "itemsPerPage": 2,
    "startIndex": 1,
    "Resources": [
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "id": "4kJpD7FC2C3ALSmp7ozAp2LZu2ZTaTCP4QZUnNu43XX3tUdhg",
            "meta": {
                "resourceType": "User",
                "created": "2023-11-10T08:19:17Z",
                "lastModified": "2024-01-13T01:04:37Z",
                "location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/4kJpD7FC2C3ALSmp7ozAp2LZu2ZTaTCP4QZUnNu43XX3tUdhg"
            },
            "userName": "example@nulab.com",
            "displayName": "AHorowitz",
            "preferredLanguage": "en",
            "locale": "en",
            "active": true,
            "roles": [
                {
                    "value": "ADMIN",
                    "primary": true
                }
            ]
        },
        {
            "schemas": [
                "urn:ietf:params:scim:schemas:core:2.0:User"
            ],
            "id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
            "externalId": "BradMarshalls",
            "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": "example2@nulab.com",
            "displayName": "BradMarshalls",
            "preferredLanguage": "en",
            "locale": "en",
            "timezone": "Asia/Tokyo",
            "active": true,
            "roles": [
                {
                    "value": "USER",
                    "primary": true
                }
            ]
        }
    ],
    "id": null,
    "externalId": null,
    "meta": null
}

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