List IDPs

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

Lists IDPs.

Response

Response body

object

meta

object

required

Paging settings for requested data.

limit

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.

offset

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.

total_count

integer

required

≥ 0

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

objects

array of objects

required

IDPs.

objects*

object

app_count

integer

Count of applications associated with the IDP.

attribute_map

object

Additional attributes to include with the access_token response.

auth_request_signed

boolean

Whether the authentication request is signed.

auth_response_encrypt

boolean

Enables authentication response encryption.

background_image

string | null

The name of the background image.

background_image_file_name

string | null

The filename of the portal background image.

cert

string | null

Body of the certificate.

client_cert

string | null

The client certificate.

client_principle_name

string

length ≥ 1

The principle name expected by the server in order to authenticate a client request.

company_id

string

length ≥ 1

The company ID.

cookie_expiry

integer

≥ 0

The number of minutes the session cookie expires.

created_at

string

ISO 8601 timestamp marking the IDP configuration's creation.

default_language

string

length ≥ 1

The default language.

description

string | null

A description of the IDP configuration.

directory_count

integer

The directory count.

directory_list

array of strings

Directory IDs for the IDP.

directory_list

dns_added

boolean

Whether the authentication request includes the DNS information.

domain_suffix

string

length ≥ 0

The domain suffix. For example, .com.

domains

array of strings or null

Domains for the IDP.

domains

enable_access_client

boolean

Enables the access client.

enable_mfa

boolean

Enables multifactor authentication.

favicon_image

string | null

The filename of the portal favicon image.

helpdesk_email

string

The email address for contacting helpdesk with issues.

idp_deployed

boolean

Whether the IDP is deployed.

idp_operational

integer

Whether the IDP is operational. Either 0 for no or 1 for yes.

1

idp_status

integer

The status of the IDP. Either 1 for 2 for 3 for 4 or 5 for deploy failed.

1 2 3 4 5

idp_type

integer

required

Defaults to 1

The type of IDP. Select 1 for Default, 2 for EAA, 3 for SAML, 4 for Okta, 5 for PingOne, 6 for OneLogin, 7 for Google, 8 for OIDC, and 9 for Azure.

1 2 3 4 5 6 7 8 9

iwa_keytab

array of strings

A unique keytab for a service principle name (SPN) used for Integrated Windows Authentication (IWA). Either true or false.

iwa_keytab

lockout_interval

integer

≥ 0

Defaults to 15

The number of minutes to lock out the user, 15 by default.

login_cname

string | null

The login cname URL.

login_dialin_server

string | null

The URL of the login dialin server.

login_domain

integer | null

The type of portal domain that end users access. Either 1 for custom login domain or 2 for WAPP login domain.

1 2

login_host

string | null

The service provider login host.

login_lockout

string

Defaults to off

Enables a temporary lockout for failed login attempts. Either on or off. The default value is off.

on off

login_suffix

string

length ≥ 0

The login suffix. For example, .com.

logo

string | null

The name of the portal logo.

logo_file_name

string | null

The portal logo filename.

logout_url

string | null

The single logout URL for SSO.

max_login_failures

integer

≥ 1

Defaults to 5

The number of login failures allowed per user before temporary lock out. The default value is 5.

metadata

string | null

The metadata of the SAML type IDP.

mfa_settings

object

Multifactor authentication settings for the IDP configuration.

modified_at

string | null

The ISO 8601 timestamp marking the last modification.

multilang_fields

string | null

Multi language field for SAML message configuration.

name

string

required

length ≥ 1

The name of the IDP configuration.

ocsp

string | null

Unicode string data.

oidcclients

string

The unique ID of the OIDC client.

pop

string

length ≥ 1

The pop resource URI.

popName

string

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

resource

string

length ≥ 1

The IDP directory resource name.

resource_uri

object

Specifies the location of various IDP resources.

saml_url

string | null

The URL of the service provider SAML interface.

settings

object

status

integer

Defaults to 1

The IDP configuration status. 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

trust_expiry

integer

≥ 0

The number of seconds to expire the authentication request.

uuid_url

string

length ≥ 1

The unique UUID URL of the IDP configuration.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://hostname/crux/v1/mgmt-pop/idp \
3
     --header 'accept: application/json'


xxxxxxxxxx
138
}
1
{
2
  "meta": {
3
    "limit": 20,
4
    "next": null,
5
    "offset": 0,
6
    "previous": null,
7
    "total_count": 2
8
  },
9
  "objects": [
10
    {
11
      "app_count": 0,
12
      "attribute_map": {},
13
      "auth_request_signed": false,
14
      "auth_response_encrypt": false,
15
      "background_image": null,
16
      "background_image_file_name": null,
17
      "cert": null,
18
      "client_cert": null,
19
      "client_principle_name": "<sAMAccountName>",
20
      "company_id": "regv3ds",
21
      "cookie_expiry": 120,
22
      "created_at": "2019-07-08T10:31:20.007541",
23
      "default_language": "english",
24
      "description": null,
25
      "directory_count": 0,

200Successful response.