List Memberships

List memberships of accounts the user can access.

application/json

Body

result

required

Any of

allOf {2}

array[object (membership) {7}]

allOf {2}

One of

array[object (membership) {7}]

object

account

object

schemas-account

read-onlyoptional

api_access_enabled

boolean | null

api_access_enabled

optional

Enterprise only. Indicates whether or not API access is enabled specifically for this user on a given account.

Example:

true

code

string

code

read-onlyoptional

The unique activation code for the account membership.

<= 64 characters

Example:

05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0

string

membership_components-schemas-identifier

read-onlyoptional

Membership identifier tag.

<= 32 characters

Example:

4536bcfad5faccb111b47003c79917fa

permissions

object

read-onlyoptional

All access permissions for the user at the account.

Example:

{"analytics":{"read":true,"write":false},"zones":{"read":true,"write":true}}

roles

array[string]

roles

read-onlyoptional

List of role names for the user at the account.

status

enum<string>

schemas-status

optional

Status of this membership.

Allowed values:

acceptedpendingrejected

Example:

accepted

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "account": {
                "created_on": "2014-03-01T12:21:02.0000Z",
                "id": "023e105f4ecef8ad9ca31a8372d0c353",
                "name": "Demo Account",
                "settings": {
                    "enforce_twofactor": false,
                    "use_account_custom_ns_by_default": false
                }
            },
            "api_access_enabled": true,
            "code": "05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0",
            "id": "4536bcfad5faccb111b47003c79917fa",
            "permissions": {
                "analytics": {
                    "read": true,
                    "write": false
                },
                "zones": {
                    "read": true,
                    "write": true
                }
            },
            "roles": [
                "Account Administrator"
            ],
            "status": "accepted"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

Request

Request samples

Responses