List IDP directories

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

Gets a list of IDP directories.

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

length ≥ 1

IDP directory data.

objects*

object

admin_pwd

string | null

The administrator user password for the IDP directory.

admin_user

string | null

The administrator user account for the IDP directory.

agents

array of objects

length ≥ 0

Connectors assigned to this IDP directory.

agents

object

name

string

required

length ≥ 1

The name of the connector.

uuid_url

string

required

length ≥ 1

A unique identifier for the connector.

api_key

string | null

The API key of the IDP directory.

attribute_map

object

The attribute mapping for the IDP directory.

auth_request_signed

boolean

Indicates a signed authentication request.

auth_response_encrypt

boolean

Enables authentication response encryption.

chase_referral

boolean

Enables referral chasing.

cname

string | null

The IDP directory cname.

company_id

string | null

The company ID of the IDP directory.

conf_state

integer

The configuration state of the IDP directory. Either 0 for not configured or 1 for configured.

1

created_at

string | null

ISO 8601 timestamp marking the IDP directory object's creation.

description

string | null

A description of the directory object.

dialin_sni

string | null

The dial-in SNI for the IDP directory.

directories

array of strings

The unique IDs of the directories for the IDP.

directories

directory_status

integer

The status of the directory. Either 1 for not added, 2 for added, 3 for no agent, 4 for pending, 5 for unreachable, or 6 for okay.

1 2 3 4 5 6

directory_type

integer

Defaults to 2

The type of directory. Either 1 for cloud, 2 for enterprise, 3 for third party, 4 for Akamai, or 5 for Akamai MSP.

1 2 3 4 5

domains

array of objects

The directory's domains.

domains

object

name

string

The domain name.

global_catalog

boolean

Enables global catalog.

group_base_dn

string | null

The base Distinguished Name (DN) that identifies the group entry in an IDP directory. A series of comma-delimited pairs formed as key=value.

group_count

integer

≥ 0

The number of groups for the IDP directory.

group_members

string

length ≥ 1

The members of the group.

group_name

string

length ≥ 1

The name of the group.

group_object_classes

array of strings

Group object classes that define custom LDAP mappings of users and groups.

group_object_classes

group_search_filter

string

length ≥ 1

The search filter for the group, such as (objectClass=group).

group_token

string

length ≥ 1

The primary group token.

host

string | null

The IDP directory host.

idp

string

The unique ID of the IDP to assign to the directory.

kerb_realms

array of objects

length ≥ 0

Kerberos realms for the IDP directory.

kerb_realms

object

kdclist

object

required

Kerberos Key Distribution Centers (KDC) information.

realm

string

required

length ≥ 1

The kerberos realm.

last_sync

string

ISO 8601 timestamp marking the IDP directory's last synchronization.

logout_url

string | null

The logout URL for the directory.

metadata

string | null

The IDP directory metadata.

mfa

string

Enables multifactor authentication. Either an on or off string.

on off

modified_at

string

ISO 8601 timestamp marking the directory's last modification.

name

string

length ≥ 1

The name of the IDP directory.

nameidformat

string | null

The name ID format.

ou_attr

string | null

The organization unit's attributes.

ou_filter

string | null

The organization unit to filter by. Specify null if you want to provide this later.

ou_object_classes

array of strings

length ≥ 1

The organization unit's object classes.

ou_object_classes

password_change_allow

boolean

Allows password changes.

password_change_threshold

integer

≥ 0

The password change threshold in seconds.

password_complexity_message

string | null

The password complexity message.

password_expire_warn_threshold

integer

≥ 0

The password expiration warning threshold in seconds.

password_filter

object

The password format requirement filters.

password_policy_default

string

length ≥ 0

The default password policy for the IDP directory.

password_reset_allow

boolean

Whether to allow password reset.

port

integer

≥ 0

The port number of the IDP directory.

resource

string

length ≥ 1

The IDP directory resource name.

resource_uri

object

Specifies the location of various IDP directory resources.

root_dn

string | null

The root distinguished name of the IDP directory. A series of comma-delimited pairs formed as key=value.

schema_attributes

string

length ≥ 1

The directory schema attributes.

server_cert_validate

boolean

Whether to validate server certificates.

service

integer

The type of directory service. Refer to Directory service configuration for available values.

1 2 3 4 5 6 7 8 9 10 11

signed_request

boolean

Whether the request is signed.

ssl

boolean

Enables SSL.

status

integer

The directory status. Either 0 for disabled or 1 for enabled.

1

sync_interval

integer

≥ 0

The synchronization interval of the IDP directory in seconds.

sync_state

integer

The IDP directory synchronization state. Refer to Directory service configuration for available values.

1 2 3 4 5 6

user_base_dn

string | null

The base distinguished name of a user. A series of comma-delimited pairs formed as key=value.

user_count

integer

≥ 0

The total count of users in the IDP directory.

user_display_name

string

length ≥ 1

The display name of a user.

user_email

string

The email of a user.

user_fname

string

length ≥ 1

The first name of a user.

user_lname

string

length ≥ 1

The last name of a user.

user_memberof

string

length ≥ 1

The member status of a user.

user_memberuid

string

length ≥ 1

The member UID of a user.

user_object_classes

array of strings

length ≥ 1

The user's object class.

user_object_classes

user_phone_num

string

length ≥ 1

The phone number of a user.

user_principal

string

length ≥ 1

The login of a user.

user_samaccountname

string

length ≥ 1

The kerberos client principal name.

user_search_filter

string

length ≥ 1

The search filter for a user.

user_upn

string

length ≥ 1

The principal name of a user.

uuid_url

string

length ≥ 1

A unique identifier for the directory.

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/idpdirectory \
3
     --header 'accept: application/json'


xxxxxxxxxx
107
}
1
{
2
  "meta": {
3
    "limit": 250,
4
    "next": null,
5
    "offset": 0,
6
    "previous": null,
7
    "total_count": 5
8
  },
9
  "objects": [
10
    {
11
      "admin_user": null,
12
      "agents": [],
13
      "api_key": null,
14
      "attribute_map": {
15
        "user.countryCode": "cloud.country_code",
16
        "user.email": "cloud.email",
17
        "user.firstName": "cloud.first_name",
18
        "user.lastName": "cloud.last_name",
19
        "user.netbios": "cloud.netbios",
20
        "user.persistentId": "cloud.uuid",
21
        "user.phoneNumber": "cloud.phone_number",
22
        "user.samAccountName": "cloud.samaccountname",
23
        "user.userPrincipleName": "cloud.user_principle_name"
24
      },
25
      "auth_request_signed": false,

200Successful operation.