Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Current »

Get a list of Identity Resource configuration data.

IdentityResource Object Reference

Request

Method: GET

URI: /api/configuration/allData

Headers

Name

Type

Description

X-SurePassID-Api-Key

string

An API Key with 'Reader' role.

Query String

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 Identity Resource names to list.
Default: All identity resources.

Response

Status: 200 OK

 Successful JSON response.
{
    "IdentityResources": [
        {
            "Required": false,
            "Emphasize": true,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "address",
            "DisplayName": "Your postal address",
            "UserClaims": [
                "address"
            ],
            "Properties": {}
        },
        {
            "Required": true,
            "Emphasize": false,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "email",
            "DisplayName": "email",
            "UserClaims": [
                "email",
                "email_verified"
            ],
            "Properties": {}
        },
        {
            "Required": true,
            "Emphasize": false,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "name",
            "DisplayName": "name",
            "UserClaims": [
                "name"
            ],
            "Properties": {}
        },
        {
            "Required": true,
            "Emphasize": false,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "openid",
            "DisplayName": "Your user identifier",
            "UserClaims": [
                "sub"
            ],
            "Properties": {}
        },
        {
            "Required": false,
            "Emphasize": true,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "phone",
            "DisplayName": "Your phone number",
            "UserClaims": [
                "phone_number",
                "phone_number_verified"
            ],
            "Properties": {}
        },
        {
            "Required": false,
            "Emphasize": true,
            "ShowInDiscoveryDocument": true,
            "Enabled": true,
            "Name": "profile",
            "DisplayName": "User Profile",
            "Description": "Your user profile information (first name, last name, etc.)",
            "UserClaims": [
                "name",
                "family_name",
                "given_name",
                "email"
            ],
            "Properties": {}
        }
    ]
}

Status: 401 Unauthorized

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

  • No labels