Get a list of API Resource configuration data.

Request

Method: GET

URI: /api/configuration/apiResourceList

Headers

Name	Type	Description

Name	Type	Description
X-SurePassID-Api-Key	string	An API Key with 'Reader' role.

Query String

Name	Type

Name	Type
includeNulls	boolean	Show/don't show JSON properties that have null values. Default: false (don't show null property values)
names	string	A comma delimited list of URL encoded API Resource names to list. Default: All API resources.

Response

Status: 200 OK

{
    "ApiResources": [
        {
            "ApiSecrets": [
                {
                    "Value": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=",
                    "Type": "SharedSecret"
                }
            ],
            "Scopes": [],
            "Enabled": true,
            "Name": "api1",
            "DisplayName": "api1",
            "UserClaims": [],
            "Properties": {}
        },
        {
            "ApiSecrets": [
                {
                    "Value": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=",
                    "Type": "SharedSecret"
                }
            ],
            "Scopes": [
                {
                    "Name": "api2.full_access",
                    "DisplayName": "api2.full_access",
                    "Required": false,
                    "Emphasize": false,
                    "ShowInDiscoveryDocument": true,
                    "UserClaims": []
                },
                {
                    "Name": "api2.read_only",
                    "DisplayName": "api2.read_only",
                    "Required": false,
                    "Emphasize": false,
                    "ShowInDiscoveryDocument": true,
                    "UserClaims": []
                },
                {
                    "Name": "api2.internal",
                    "Required": false,
                    "Emphasize": false,
                    "ShowInDiscoveryDocument": false,
                    "UserClaims": [
                        "internal_id"
                    ]
                }
            ],
            "Enabled": true,
            "Name": "api2",
            "DisplayName": "api2",
            "UserClaims": [
                "name",
                "email"
            ],
            "Properties": {}
        }
    ]
}

Status: 401 Unauthorized

{
    "type": "https://httpstatuses.com/401",
    "title": "Unauthorized",
    "status": 401
}

Product Documentation

List API Resource Configuration Data

Analytics

Request

Headers

Query String

Response

Related content