List all access

This endpoint allows you to list and search for access.

Endpoint

GET /user/v1/access

Parameters

Name	Location	Required	Type	Default value	Description
customer_id	URL	No	Integer	Connected user's customer ID	Search for access belonging to this customer. By default, the id of the customer associated to the connected user will be used
include_subsidiaries	URL	No	Boolean	true	Include access belonging to the customer subsidiaries
limit	URL	No	Integer	100	Number of access to return (max 500)
offset	URL	No	Integer	0	Offset used
sort[]	URL	No	String[]	["user:asc"]	Sort results by one or more fields. Sortable fields are : user, type, customer_id.
user	URL	No	String		Search for access by user id. This parameter accepts a * wildcard.
type	URL	No	String		Search for access by type. This parameter accepts a * wildcard.

Response

A AccessSearchResult object.

Example Request

GET /user/v1/access?customer_id=1234&limit=10&offset=10&sort[]=user:asc&type=api_connection

Example Response

{
    "message": "OK",
    "data": {
        "total": 9,
        "include_subsidiaries": true,
        "limit": 3,
        "offset": 3,
        "sort": [
            "user:asc"
        ],
        "results": [
            {
                "id": 433510,
                "user": "9a1b49cb-329f-421e-b6c2-145451633dc8",
                "type": "api_connection",
                "customer_id": 1234,
                "roles": [
                    "CLIENTNMS_WEBSERVICE_EVENT_R"
                ],
                "last_login_at": null,
                "language": "en",
                "name": "Event API access only",
                "created_at": "2023-01-10T00:00:00+00:00",
                "created_by": {
                    "id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
                    "firstname": "Company",
                    "lastname": "Administrator"
                }
            },
            {
                "id": 433515,
                "user": "c0b48140-34cb-4187-acd7-aaa830dc97f9",
                "type": "api_connection",
                "customer_id": 1234,
                "roles": [
                    "CLIENTNMS_WEBSERVICE_EVENT_R",
                    "CLIENTNMS_WEBSERVICE_DNS_RW"
                ],
                "last_login_at": null,
                "language": "en",
                "name": "New application API access",
                "created_at": "2023-01-01T00:00:00+00:00",
                "created_by": {
                    "id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
                    "firstname": "Company",
                    "lastname": "Administrator"
                }
            },
            {
                "id": 433515,
                "user": "c0b48140-34cb-4187-acd7-aaa830dc97f9",
                "type": "api_connection",
                "customer_id": 1235,
                "roles": [
                    "CLIENTNMS_WEBSERVICE_DNS_RW"
                ],
                "last_login_at": null,
                "language": "en",
                "name": "Zone management API access",
                "created_at": "2023-01-01T00:00:00+00:00",
                "created_by": {
                    "id": "7a1506b9-9ce4-43f9-a6f0-e94ef4252277",
                    "firstname": "Company",
                    "lastname": "Administrator"
                }
            }
        ]
    }
}