API
Start typing to search…

List directory applications

get https://{hostname}/crux/v1/mgmt-pop/directories//apps

Gets list of applications associated with the directory.

Path Params
string
required

A unique identifier for each directory.

Query Params
string
required

The Akamai contract identifier for your Enterprise Application Access product.

string

For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Response

Response body
object
meta
object
required

Paging settings for requested data.

integer
required
0 to 250

The number of items requested, maximum of 250.

string | null
required

To navigate, replace the current URL's query string with this value, then GET that modified URL. This value is null when you're on the last page.

integer
required
≥ 0

The offset from the beginning of the underlying object list, starting at 0.

string | null
required

To navigate, replace the current URL's query string with this value, then GET that modified URL. This value is null when you're on the first page.

integer
required
≥ 0

The total count of resources that are in the underlying object list.

objects
array of objects
required
length ≥ 1

List of applications for the account.

objects*
object
advanced_settings
object

Application config version advanced settings.

agents
array of objects
length ≥ 1

Target connectors for deploying the application configuration.

agents
object
boolean
required

Whether the target connector is compatible with the application configuration.

string
required
length ≥ 1

The name of the connector.

string
required
length ≥ 1

The UUID URL of the connector.

app
object

Specifies the application for the application directory.

app_category
object

Specifies the category the application belongs to.

boolean

Whether the application configuration is deployed.

string
length ≥ 1

A URL identifying the application configuration's logo icon.

integer
Defaults to 1

The operational status of the application configuration. Either 1 for No, 2 for Pending, or 3 for Okay.

1 2 3

integer
Defaults to 1

The access application profile. Either 1 for HTTP, 2 for SharePoint, 3 for Jira, 4 for RDP, 5 for VNC, 6 for ssh, 7 for Jenkins, 8 for Confluence, or 9 for TCP.

1 2 3 4 5 6 7 8 9

integer
Defaults to 1

The status of the application configuration. Either 1 for not ready, 2 for ready, 3 for pending, 4 for deployed, 5 for failed, 6 for cloud deployed, or 7 for connector deployed.

1 2 3 4 5 6 7

integer

The type of application configuration. Either 1 for Enterprise Hosted, 2 for SAAS, 3 for Bookmark, 4 for Tunnel, or 5 for Enterprise Threat Protector.

1 2 3 4 5

string | null

The connector for the application.

string
length ≥ 1
Defaults to true

Enables authentication.

integer
Defaults to 1

The type of authentication used. Either 1 for Cloud, 2 for Enterprise, or 3 for Third Party.

1 2 3

string
length ≥ 0

The Okta Bookmark app URL.

string | null

A valid certificate string for front-end SSL connections. Used if you configure your domain as the external hostname. Specify null if you want to name it later.

integer
Defaults to 1

The mode of client app. 1 for TCP or 2 for Tunnel.

1 2

string | null

The upstream URL for a CNAME redirect.

string

Read-only ISO 8601 timestamp marking the application object's creation.

string | null

The data connector for the application.

string
length ≥ 1

A description of the application.

directories
array of objects
length ≥ 1

Application directory details for validating user accounts.

directories
object
string
required
length ≥ 1

The name of the directory.

integer
required

The type of directory. Select 1 for EAA Cloud Directory, 2 for Active Directory, 3 for LDAP, or 4 for Active Directory LDS.

1 2 3 4

integer
required
≥ 0

The total number of user accounts configured on the directory.

string
required
length ≥ 1

The UUID URL of the directory.

directory
object

Directory properties.

integer
Defaults to 1

The type of access domain. Select 1 for custom or 2 for Akamai.

1 2

string
length ≥ 0

The domain suffix. For example, .com.

string

Enables multifactor authentication. Either enable or use to inherit to use the IDP's MFA settings.

inherit enable

string | null

The external default hostname for the application.

idp
object

Specifies the identity provider (IDP) for authenticating user requests.

string
length ≥ 1

Name of the user who most recently modified this application object. If the object wasn't modified since first being created, the value matches createdAt.

string
length ≥ 0

The name of the application configuration.

boolean

Enables OpenID Connect (OIDC).

object | null

JSON settings to implement OIDC.

string

Whether the origin host uses TLS encryption.

string | null

The IP address or FQDN of the application origin server.

integer

The application's origin port.

string
length ≥ 0

The identifier for the target region to deploy the application.

string
length ≥ 0

The target region to deploy the application. For example, US-West or US-East.

string
length ≥ 1

The version of remote desktop protocol (RDP).

string
length ≥ 1

Name of resource mapping to an entity or set of entities. For example, apps.

resource_status
object

The most recent status of various application resources.

resource_uri
object

Related resource URIs for the application.

boolean

Enables SAML for the application.

saml_settings
array of objects
length ≥ 1

SAML configuration for an application.

saml_settings
object
attrmap
array of objects
required
length ≥ 1

SAML attribute mapping details.

attrmap*
object
string
required

The name format of the attribute. Either email, basic, persistent, unspecified, or transient.

email basic unspecified persistent transient

string
length ≥ 0

The fname of the attribute.

string
required
length ≥ 1

The name of the attribute.

string
length ≥ 1

The custom rule language for the attribute.

string
required
length ≥ 1

The source of the attribute.

string
length ≥ 1

The value of the attribute.

idp
object
required

Specifies identity provider (IDP) settings for the SAML configuration.

sp
object
required

Specifies service provider (SP) settings for the SAML configuration.

subject
object
required

Specifies the subject settings for the SAML configuration.

servers
array of objects
length ≥ 0

Origin server details of the internal application within your network.

servers
object
string
length ≥ 1

The name of the origin server.

boolean
required

Enables TLS on the origin server.

string | null
required

The IP address or FQDN of the origin server.

integer
required
≥ 0

The port number of the origin server.

string
required

The protocol of the origin server connection. Either ssh or http.

ssh http

services
array of objects
length ≥ 1

Services enabled on the application configuration.

services
object
string
length ≥ 1

The name of the service.

string
length ≥ 1

The unique ID of the service.

sites
array of strings
length ≥ 1

List of associated site resources.

sites
Defaults to 1

The status of the application configuration. Either 1 for not ready, 2 for ready, 3 for pending, 4 for deployed, 5 for failed, 6 for cloud deployed, or 7 for connector deployed.

string
length ≥ 1

A unique identifier for the application.

boolean

Enables Web Services Federation (WSFED) identity federation.

wsfed_settings
array of objects
length ≥ 1

JSON settings to implement WSFED.

Web Services Federation (WSFED) settings
object
attrmap
array of objects
required
length ≥ 1

Mapped attributes for the WSFED configuration.

attrmap*
object
string
length ≥ 1

The custom format of the attribute.

string
required
length ≥ 1

The name format of the attribute.

string
length ≥ 1

The name of the attribute.

string
length ≥ 1

The custom rule language for the attribute.

string
length ≥ 1

The source of the attribute.

string
length ≥ 1

The value of the attribute.

idp
object
required

Specifies identity provider (IDP) settings for the WSFED configuration.

sp
object
required

Specifies service provider settings for the WSFED configuration.

subject
object
required

Specifies subject settings for the WSFED configuration.

Updated 6 months ago

Did this page help you?
Language
Authentication
Remember to add your authentication credentials to run this code.
URL

Updated 6 months ago

Did this page help you?