API
Start typing to search…

Modify an IDP directory

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

Updates an existing IDP directory.

Path Params
string
required

A unique identifier for each IDP 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.

Body Params
string | null

The administrator user password for the IDP directory.

string | null

The administrator user account for the IDP directory.

agents
array of objects
length ≥ 0

Connectors assigned to this IDP directory.

agents
string | null

The API key of the IDP directory.

attribute_map
object

The attribute mapping for the IDP directory.

boolean

Indicates a signed authentication request.

boolean

Enables authentication response encryption.

boolean

Enables referral chasing.

string | null

The IDP directory cname.

string | null

The company ID of the IDP directory.

integer
enum

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

Allowed:
string | null

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

string | null

A description of the directory object.

string | null

The dial-in SNI for the IDP directory.

directories
array of strings

The unique IDs of the directories for the IDP.

directories
integer
enum

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.

Allowed:
integer
enum
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.

Allowed:
domains
array of objects

The directory's domains.

domains
boolean

Enables global catalog.

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.

integer
≥ 0

The number of groups for the IDP directory.

string
length ≥ 1

The members of the group.

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
string
length ≥ 1

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

string
length ≥ 1

The primary group token.

string | null

The IDP directory host.

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
string

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

string | null

The logout URL for the directory.

string | null

The IDP directory metadata.

string
enum

Enables multifactor authentication. Either an on or off string.

Allowed:
string

ISO 8601 timestamp marking the directory's last modification.

string
length ≥ 1

The name of the IDP directory.

string | null

The name ID format.

string | null

The organization unit's attributes.

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
boolean

Allows password changes.

integer
≥ 0

The password change threshold in seconds.

string | null

The password complexity message.

integer
≥ 0

The password expiration warning threshold in seconds.

password_filter
object

The password format requirement filters.

string
length ≥ 0

The default password policy for the IDP directory.

boolean

Whether to allow password reset.

integer
≥ 0

The port number of the IDP directory.

string
length ≥ 1

The IDP directory resource name.

resource_uri
object

Specifies the location of various IDP directory resources.

string | null

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

string
length ≥ 1

The directory schema attributes.

boolean

Whether to validate server certificates.

integer
enum

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

boolean

Whether the request is signed.

boolean

Enables SSL.

integer
enum

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

Allowed:
integer
≥ 0

The synchronization interval of the IDP directory in seconds.

integer
enum

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

Allowed:
string | null

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

integer
≥ 0

The total count of users in the IDP directory.

string
length ≥ 1

The display name of a user.

string

The email of a user.

string
length ≥ 1

The first name of a user.

string
length ≥ 1

The last name of a user.

string
length ≥ 1

The member status of a user.

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
string
length ≥ 1

The phone number of a user.

string
length ≥ 1

The login of a user.

string
length ≥ 1

The kerberos client principal name.

string
length ≥ 1

The search filter for a user.

string
length ≥ 1

The principal name of a user.

string
length ≥ 1

A unique identifier for the directory.

Response

Updated about 1 month ago

Language
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 1 month ago