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 3 Next »

Get a list of all the IdentityProvider configuration data.

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) 

Response

Status: 200 OK

 Successful JSON response.
{
    "Clients": [
        {
            "Enabled": true,
            "ClientId": "client_name",
            "ProtocolType": "oidc",
            "ClientSecrets": [
                {
                    "Value": "K7gNU3sdo+OL0wNhqoVWhr3g6s1xYv72ol/pe/Unols=",
                    "Type": "SharedSecret"
                }
            ],
            "RequireClientSecret": true,
            "ClientName": "SurePassID Client",
            "RequireConsent": true,
            "AllowRememberConsent": true,
            "AllowedGrantTypes": [
                "hybrid"
            ],
            "RequirePkce": false,
            "AllowPlainTextPkce": false,
            "AllowAccessTokensViaBrowser": false,
            "RedirectUris": [
                "https://oidc-client.surepassid.com/signin-oidc"
            ],
            "PostLogoutRedirectUris": [
                "https://oidc-client.surepassid.com/signout-callback-oidc"
            ],
            "FrontChannelLogoutSessionRequired": true,
            "BackChannelLogoutSessionRequired": true,
            "AllowOfflineAccess": false,
            "AllowedScopes": [
                "openid",
                "profile"
            ],
            "AlwaysIncludeUserClaimsInIdToken": true,
            "IdentityTokenLifetime": 300,
            "AccessTokenLifetime": 3600,
            "AuthorizationCodeLifetime": 300,
            "AbsoluteRefreshTokenLifetime": 2592000,
            "SlidingRefreshTokenLifetime": 1296000,
            "RefreshTokenUsage": 1,
            "UpdateAccessTokenClaimsOnRefresh": false,
            "RefreshTokenExpiration": 1,
            "AccessTokenType": 0,
            "EnableLocalLogin": true,
            "IdentityProviderRestrictions": [],
            "IncludeJwtId": false,
            "Claims": [],
            "AlwaysSendClientClaims": false,
            "ClientClaimsPrefix": "client_",
            "DeviceCodeLifetime": 300,
            "AllowedCorsOrigins": [],
            "Properties": {
                "foo": "bar"
            }
        }
    ],
    "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": {}
        }
    ],
    "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
}
  • No labels