Load All Applications | API Reference

Authorization

Descope Project ID and Management Key

AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Load all Applications within a project

This endpoint returns details of all Applications within your Descope project.

{
  "apps": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "enabled": true,
      "logo": "string",
      "appType": "string",
      "samlSettings": {
        "loginPageUrl": "string",
        "idpCert": "string",
        "useMetadataInfo": true,
        "metadataUrl": "string",
        "entityId": "string",
        "acsUrl": "string",
        "certificate": "string",
        "attributeMapping": [
          {
            "name": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "groupsMapping": [
          {
            "name": "string",
            "type": "string",
            "filterType": "string",
            "value": "string",
            "roles": [
              {
                "id": "string",
                "name": "string"
              }
            ]
          }
        ],
        "idpMetadataUrl": "string",
        "idpEntityId": "string",
        "idpSsoUrl": "string",
        "acsAllowedCallbacks": [
          "string"
        ],
        "subjectNameIdType": "string",
        "subjectNameIdFormat": "string",
        "defaultRelayState": "string",
        "idpInitiatedUrl": "string",
        "forceAuthentication": true,
        "idpLogoutUrl": "string",
        "logoutRedirectUrl": "string",
        "errorRedirectUrl": "string",
        "defaultSignatureAlgorithm": "string"
      },
      "oidcSettings": {
        "loginPageUrl": "string",
        "issuer": "string",
        "discoveryUrl": "string",
        "claims": [
          "string"
        ],
        "forceAuthentication": true,
        "jwtBearerSettings": {
          "issuers": {
            "property1": {
              "jwksUri": "string",
              "signAlgorithm": "string",
              "userInfoUri": "string",
              "externalIdFieldName": "string"
            },
            "property2": {
              "jwksUri": "string",
              "signAlgorithm": "string",
              "userInfoUri": "string",
              "externalIdFieldName": "string"
            }
          },
          "jwtBearerGrantTypeAudienceToUse": "string",
          "jwtBearerGrantTypeScopeToUse": "string",
          "jwtBearerGrantTypeCustomClaimsToUse": "string"
        },
        "backChannelLogoutUrl": "string",
        "customIdpInitiatedLoginPageUrl": "string"
      },
      "customSettings": {
        "loginPageUrl": "string"
      },
      "wsfedSettings": {
        "loginPageUrl": "string",
        "realm": "string",
        "replyUrl": "string",
        "attributeMapping": [
          {
            "name": "string",
            "type": "string",
            "value": "string"
          }
        ],
        "groupsMapping": [
          {
            "name": "string",
            "type": "string",
            "filterType": "string",
            "value": "string",
            "roles": [
              {
                "id": "string",
                "name": "string"
              }
            ]
          }
        ],
        "forceAuthentication": true,
        "logoutRedirectUrl": "string",
        "errorRedirectUrl": "string",
        "idpCert": "string",
        "idpInitiatedUrl": "string",
        "idpMetadataUrl": "string",
        "idpEntityId": "string",
        "idpSsoUrl": "string",
        "idpLogoutUrl": "string"
      }
    }
  ]
}

{  "apps": [    {      "id": "string",      "name": "string",      "description": "string",      "enabled": true,      "logo": "string",      "appType": "string",      "samlSettings": {        "loginPageUrl": "string",        "idpCert": "string",        "useMetadataInfo": true,        "metadataUrl": "string",        "entityId": "string",        "acsUrl": "string",        "certificate": "string",        "attributeMapping": [          {            "name": "string",            "type": "string",            "value": "string"          }        ],        "groupsMapping": [          {            "name": "string",            "type": "string",            "filterType": "string",            "value": "string",            "roles": [              {                "id": "string",                "name": "string"              }            ]          }        ],        "idpMetadataUrl": "string",        "idpEntityId": "string",        "idpSsoUrl": "string",        "acsAllowedCallbacks": [          "string"        ],        "subjectNameIdType": "string",        "subjectNameIdFormat": "string",        "defaultRelayState": "string",        "idpInitiatedUrl": "string",        "forceAuthentication": true,        "idpLogoutUrl": "string",        "logoutRedirectUrl": "string",        "errorRedirectUrl": "string",        "defaultSignatureAlgorithm": "string"      },      "oidcSettings": {        "loginPageUrl": "string",        "issuer": "string",        "discoveryUrl": "string",        "claims": [          "string"        ],        "forceAuthentication": true,        "jwtBearerSettings": {          "issuers": {            "property1": {              "jwksUri": "string",              "signAlgorithm": "string",              "userInfoUri": "string",              "externalIdFieldName": "string"            },            "property2": {              "jwksUri": "string",              "signAlgorithm": "string",              "userInfoUri": "string",              "externalIdFieldName": "string"            }          },          "jwtBearerGrantTypeAudienceToUse": "string",          "jwtBearerGrantTypeScopeToUse": "string",          "jwtBearerGrantTypeCustomClaimsToUse": "string"        },        "backChannelLogoutUrl": "string",        "customIdpInitiatedLoginPageUrl": "string"      },      "customSettings": {        "loginPageUrl": "string"      },      "wsfedSettings": {        "loginPageUrl": "string",        "realm": "string",        "replyUrl": "string",        "attributeMapping": [          {            "name": "string",            "type": "string",            "value": "string"          }        ],        "groupsMapping": [          {            "name": "string",            "type": "string",            "filterType": "string",            "value": "string",            "roles": [              {                "id": "string",                "name": "string"              }            ]          }        ],        "forceAuthentication": true,        "logoutRedirectUrl": "string",        "errorRedirectUrl": "string",        "idpCert": "string",        "idpInitiatedUrl": "string",        "idpMetadataUrl": "string",        "idpEntityId": "string",        "idpSsoUrl": "string",        "idpLogoutUrl": "string"      }    }  ]}

TypeScript

export interface Response {
apps?: {
id?: string
/**
 * int64 version - excluded
 *  int64 createdTime - excluded
 *  string projectId - copied
 */
name?: string
description?: string
enabled?: boolean
logo?: string
appType?: string
samlSettings?: SSOApplicationSAMLSettings
oidcSettings?: SSOApplicationOIDCSettings
customSettings?: SSOApplicationCustomSettings
wsfedSettings?: SSOApplicationWSFedSettings
}[]
}
export interface SSOApplicationSAMLSettings {
loginPageUrl?: string
idpCert?: string
useMetadataInfo?: boolean
metadataUrl?: string
entityId?: string
acsUrl?: string
certificate?: string
attributeMapping?: {
name?: string
type?: string
value?: string
}[]
groupsMapping?: {
name?: string
type?: string
filterType?: string
value?: string
roles?: SAMLIDPRoleGroupMappingInfo[]
}[]
idpMetadataUrl?: string
idpEntityId?: string
idpSsoUrl?: string
acsAllowedCallbacks?: string[]
subjectNameIdType?: string
subjectNameIdFormat?: string
defaultRelayState?: string
idpInitiatedUrl?: string
forceAuthentication?: boolean
idpLogoutUrl?: string
logoutRedirectUrl?: string
errorRedirectUrl?: string
defaultSignatureAlgorithm?: string
}
export interface SAMLIDPRoleGroupMappingInfo {
id?: string
name?: string
}
export interface SSOApplicationOIDCSettings {
loginPageUrl?: string
issuer?: string
discoveryUrl?: string
claims?: string[]
forceAuthentication?: boolean
jwtBearerSettings?: {
issuers?: {
[k: string]: IssuerSettings
}
jwtBearerGrantTypeAudienceToUse?: string
jwtBearerGrantTypeScopeToUse?: string
jwtBearerGrantTypeCustomClaimsToUse?: string
}
backChannelLogoutUrl?: string
customIdpInitiatedLoginPageUrl?: string
}
export interface IssuerSettings {
jwksUri?: string
signAlgorithm?: string
userInfoUri?: string
externalIdFieldName?: string
}
export interface SSOApplicationCustomSettings {
loginPageUrl?: string
}
export interface SSOApplicationWSFedSettings {
loginPageUrl?: string
realm?: string
replyUrl?: string
attributeMapping?: {
name?: string
type?: string
value?: string
}[]
groupsMapping?: {
name?: string
type?: string
filterType?: string
value?: string
roles?: SAMLIDPRoleGroupMappingInfo[]
}[]
forceAuthentication?: boolean
logoutRedirectUrl?: string
errorRedirectUrl?: string
idpCert?: string
idpInitiatedUrl?: string
idpMetadataUrl?: string
idpEntityId?: string
idpSsoUrl?: string
idpLogoutUrl?: string
}

export interface Response {apps?: {id?: string/** * int64 version - excluded *  int64 createdTime - excluded *  string projectId - copied */name?: stringdescription?: stringenabled?: booleanlogo?: stringappType?: stringsamlSettings?: SSOApplicationSAMLSettingsoidcSettings?: SSOApplicationOIDCSettingscustomSettings?: SSOApplicationCustomSettingswsfedSettings?: SSOApplicationWSFedSettings}[]}export interface SSOApplicationSAMLSettings {loginPageUrl?: stringidpCert?: stringuseMetadataInfo?: booleanmetadataUrl?: stringentityId?: stringacsUrl?: stringcertificate?: stringattributeMapping?: {name?: stringtype?: stringvalue?: string}[]groupsMapping?: {name?: stringtype?: stringfilterType?: stringvalue?: stringroles?: SAMLIDPRoleGroupMappingInfo[]}[]idpMetadataUrl?: stringidpEntityId?: stringidpSsoUrl?: stringacsAllowedCallbacks?: string[]subjectNameIdType?: stringsubjectNameIdFormat?: stringdefaultRelayState?: stringidpInitiatedUrl?: stringforceAuthentication?: booleanidpLogoutUrl?: stringlogoutRedirectUrl?: stringerrorRedirectUrl?: stringdefaultSignatureAlgorithm?: string}export interface SAMLIDPRoleGroupMappingInfo {id?: stringname?: string}export interface SSOApplicationOIDCSettings {loginPageUrl?: stringissuer?: stringdiscoveryUrl?: stringclaims?: string[]forceAuthentication?: booleanjwtBearerSettings?: {issuers?: {[k: string]: IssuerSettings}jwtBearerGrantTypeAudienceToUse?: stringjwtBearerGrantTypeScopeToUse?: stringjwtBearerGrantTypeCustomClaimsToUse?: string}backChannelLogoutUrl?: stringcustomIdpInitiatedLoginPageUrl?: string}export interface IssuerSettings {jwksUri?: stringsignAlgorithm?: stringuserInfoUri?: stringexternalIdFieldName?: string}export interface SSOApplicationCustomSettings {loginPageUrl?: string}export interface SSOApplicationWSFedSettings {loginPageUrl?: stringrealm?: stringreplyUrl?: stringattributeMapping?: {name?: stringtype?: stringvalue?: string}[]groupsMapping?: {name?: stringtype?: stringfilterType?: stringvalue?: stringroles?: SAMLIDPRoleGroupMappingInfo[]}[]forceAuthentication?: booleanlogoutRedirectUrl?: stringerrorRedirectUrl?: stringidpCert?: stringidpInitiatedUrl?: stringidpMetadataUrl?: stringidpEntityId?: stringidpSsoUrl?: stringidpLogoutUrl?: string}

Was this helpful?

Authorization

Load all Applications within a project

See Also