GET /config/access/authorized_services

Edit online

Retrieves a list of authorized services. For security reasons, the token field will never be populated in this endpoint.

To view any authorized service, the caller must have the Administrator Manager permission. Callers without the Administrator Manager permission can only see the list of authorized services that they've created. An authorized service can see itself and other authorized services that it created, but the Administrator Manager permission is needed to see the complete list of authorized services.

Table 1. GET /config/access/authorized_services resource details
MIME Type
application/json

Table 2. GET /config/access/authorized_services request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
current_authorized_service	query	Optional	Boolean	text/plain	Whether to return the current authorized service only
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /config/access/authorized_services response codes
HTTP Response Code	Unique Code	Description
200		Authorized Services retrieved.

Response Description

An array of authorized services structures.

id - Long - The ID of the authorized service. This field is read-only.
label - String - The label of the authorized service. Authorized service labels and users "usernames" must be unique between them.
token - String - The token of this authorized service, generated as a UUID. The authorized service token is a pre-authorized key. This token can be used in place of a username and password when authentication to the APIs. This field is only available in the response to a POST to the /api/config/access/authorized_services endpoint.
created_by - String - The label of the system actor that created this authorized service.
tenant_id - Long - The tenant_id of the current authorized service. Access tenants using /config/access/tenant_management/tenants API.
security_profile_id - Long - The security profile ID of the authorized service. Access deployed user roles under /api/config/security_profiles API.
user_role_id - Long - The user_role_id of the user. Access deployed user roles under /api/confg/user_roles API.
creation_date - Long - The time in milliseconds since epoch that this authorized service was created. This field is read-only.
expiration_date - Long - The time in milliseconds since epoch that this authorized service will expire. If this field is null, this authorized service does not expire.
last_used_date - Long - The time in milliseconds since epoch that this authorized service was last used. If this field is null, this authorized service has not been used.

Response Sample


[
    {
        "created_by": "String",
        "creation_date": 42,
        "expiration_date": 42,
        "id": 42,
        "label": "String",
        "last_used_date": 42,
        "security_profile_id": 42,
        "tenant_id": 42,
        "token": "String",
        "user_role_id": 42
    }
]