Gets the details of an application.

get https://{tenanturl}/v1.0/applications/{applicationId}

Entitlements required: manageAppAccessAdmin (Manage application lifecycle)

Responses

Response body

object

_links

object

self

object

name

string

required

Name of the Entity.

owners

array of objects

List[OwnerBean] , a colloction of owners of this application

owners

object

string

identifier of application Owner

name

string

name of application Owner

string

email of application Owner

userName

string

user name of application Owner

realm

string

realm name of application Owner

userType

string

identifies whether the application owner is federated or regular

familyName

string

family name of the application Owner

givenName

string

given name of the application Owner

target

array of objects

List[Map[String, String]] , a colloction of targets of this application

target

object

icon

string

represents icon for this application

defaultIcon

string

represents defaulticon for this application

customIcon

string

represents custom icon for this application

xforce

object

Map[String, Map] holds XForce application details

type

string

Type of application

templateId

string

required

ID of the template for this application

providers

object

required

saml

object

sso

object

required

bookmark

object

oidc

object

wsfed

object

attributeMappings

array of objects

List[AttributeMapBean], collection of attributeMapping.

attributeMappings

object

name

string

required

Name of the Entity.

targetName

string

required

Name of target

targetAttrFormat

string

Attribute Format for target

sourceId

string

identifier of the source associated with this Target, only applicable for mapping to Attribute Source Id.

applicationState

boolean

True if application is saved and False if it is in Draft State.

description

string

description about application

authPolicy

object

string

required

represents identifier for Authentication Policy

name

string

represents name of the Authentication Policy

Applicable only for GET endpoint calls.

grantTypes

array of objects

List of API grantTypes and the corresponding Boolean flag to indicate if the Auth Policy will be applied on it by oidc. Supported API grant types are: ropc, jwtBearer, policyAuth and refresh_token. See the 'Example Value' section for payload details.

grantTypes

object

errorCode

string

errorDescription

string

provisioningMode

string

Mode of provisioning for example SAMLJIT etc

identitySources

array of strings

List[String], a collection of application IdentitySources.

identitySources

visibleOnLaunchpad

boolean

Visibility flag for the application on launchpad.

provisioning

object

required

authentication

object

attributeMappings

array of objects

attributeMappings

object

targetName

string

Name of the attribute

sourceId

string

Unique identifier of the attribute

outboundTracking

boolean

boolean flag representing whether any change in the attribute's value should be percolated to the target

inboundTracking

boolean

boolean flag indicating if any change in the attribute's value on the target should be propagated to cloud directory.

applyTransformation

string

Specify the ruleId to indicate the transformation that needs to be carried out. To be used when advanced scripting is to be used.

ruleType

string

Rule type to indicate custom or built in rules. Indicates if this is a built in predefined rule or a custom rule.

reverseAttributeMappings

array of objects

reverseAttributeMappings

object

targetName

string

Name of the attribute

sourceId

string

Unique identifier of the attribute

outboundTracking

boolean

boolean flag representing whether any change in the attribute's value should be percolated to the target

inboundTracking

boolean

boolean flag indicating if any change in the attribute's value on the target should be propagated to cloud directory.

applyTransformation

string

Specify the ruleId to indicate the transformation that needs to be carried out. To be used when advanced scripting is to be used.

ruleType

string

Rule type to indicate custom or built in rules. Indicates if this is a built in predefined rule or a custom rule.

policies

object

extension

object

provisioningState

string

customization

object

themeId

string

required

Theme identifier for the application

devportalSettings

object

grantTypes

object

identitySources

array of strings

List[String], a collection of application IdentitySources settings for the developer portal application.

identitySources

authPolicy

object

sendAllKnownUserAttributes

string

Boolean flag setting to indicate to return all supported claims for the developer portal application.

attributeMappings

array of objects

List[AttributeMapBean], collection of attributeMapping settings for the developer portal application .

attributeMappings

object

name

string

required

Name of the Entity.

targetName

string

required

Name of target

targetAttrFormat

string

Attribute Format for target

sourceId

string

identifier of the source associated with this Target, only applicable for mapping to Attribute Source Id.

extendedProperties

object

Map<String,String> a map containing Devportal extended properties.

Has additional fields

apiAccessClients

array of objects

List of API access clients for application

apiAccessClients

object

clientName

string

required

Display client name.

clientId

string

Unique identifier for a client. Auto generated on save.

clientSecret

string

Client Secret. Will be auto-generated on save.

enabled

boolean

required

If true, client is enabled.

defaultEntitlements

array of strings

List of entitlement strings.

defaultEntitlements

accessTokenType

string

Type of token

default jwt

jwtSigningAlg

string

JWT signing algorithm.

signKeyLabel

string

Signature key label.

accessTokenLifetime

int32

Access token lifetime seconds.

restrictScopes

boolean

Restrict the scopes for application api access.

ipFilterOp

string

Operator to filter ip (allow/deny).

ipFilters

array of strings

List and/or range of IPs to filter ip based on ipFilterOp.

ipFilters

scopes

array of objects

List of scopes.

scopes

object

name

string

description

string

jwkUri

string

The URI where the relying party publishes its public keys in JSON Web Keys (JWKs) format.

additionalConfig

object

Additional OIDC configurations

adaptiveAuthentication

object

platform

string

platform name

licenseData

string

License Data

storageLink

string

Storage link

401

User not Authorised.

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v1.0/applications/applicationId \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Request is Successful.

404Invalid Application ID.