Configuration

[tags: DMA,RPRM]

Resource Root

https://localhost:8443/api/rest/config/enterprise-directory

Summary

Resources	Methods
https://localhost:8443/api/rest/config/enterprise-directory	GET Retrieves the current Enterprise Directory configuration settings. PUT Update the current Enterprise Directory configuration settings.
https://localhost:8443/api/rest/config/enterprise-directory/defaults	GET Retrieves Enterprise Directory integration defaults.
https://localhost:8443/api/rest/config/enterprise-directory/status	GET Retrieves Enterprise Directory integration status.
https://localhost:8443/api/rest/config/enterprise-directory/delegate-authentication	GET Retrieves the current Enterprise Directory delegate authentication settings. PUT Update the current Enterprise Directory delegate authentication settings.

Resources

https://localhost:8443/api/rest/config/enterprise-directory

Methods

GET

Retrieves the current Enterprise Directory configuration settings. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-config+xml application/vnd.plcm.plcm-enterprise-directory-config+json application/vnd.plcm.plcm-enterprise-directory-config-v2+xml application/vnd.plcm.plcm-enterprise-directory-config-v2+json	Information successfully retrieved
304		Enterprise Directory integration configuration has not changed since the last search. Note: The API client must provide the "plcm-enterprise-directory-config" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-enterprise-directory-config" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes on the server.
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to get the Enterprise Directory settings.

PUT

Update the current Enterprise Directory configuration settings. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-enterprise-directory-config+xml

application/vnd.plcm.plcm-enterprise-directory-config+json

application/vnd.plcm.plcm-enterprise-directory-config-v2+xml

application/vnd.plcm.plcm-enterprise-directory-config-v2+json

Response

Status	Representation	Description
204		The update of the settings was successful.
403	application/vnd.plcm.plcm-error+xml	The user does not have the correct permissions to change the Enterprise Directory configuration.
400	application/vnd.plcm.plcm-error+xml	serverless-bind was true and no host IP or FQDN was specified in the address field.
400	application/vnd.plcm.plcm-error+xml	An address is missing. An IP address, host name, or FQDN is required.
400	application/vnd.plcm.plcm-error+xml	A username is missing. Expected username to be in the format DOMAIN\username
400	application/vnd.plcm.plcm-error+xml	A password is missing.
409	application/vnd.plcm.plcm-error+xml	Expected username to be in the format DOMAIN\username
409	application/vnd.plcm.plcm-error+xml	The filter and/or base DN is too restrictive. It must not exclude the user 'DOMAIN\\username', where DOMAIN is the account domain, and username is the account requiring access.
409	application/vnd.plcm.plcm-error+xml	Enterprise directory access error
400	application/vnd.plcm.plcm-error+xml	Maximum characters used must be a number between 1 and 128
412	application/vnd.plcm.plcm-error+xml	The enterprise directory resource has changed on the server. Note: The response will contain the ETag value. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-enterprise-directory.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-enterprise-directory.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.

https://localhost:8443/api/rest/config/enterprise-directory/defaults

Methods

GET

Retrieves Enterprise Directory integration defaults. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-config+xml application/vnd.plcm.plcm-enterprise-directory-config+json application/vnd.plcm.plcm-enterprise-directory-config-v2+xml application/vnd.plcm.plcm-enterprise-directory-config-v2+json	Default Information successfully retrieved
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to retrieve the Enterprise Directory status.

https://localhost:8443/api/rest/config/enterprise-directory/status

Methods

GET

Retrieves Enterprise Directory integration status. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-status+xml application/vnd.plcm.plcm-enterprise-directory-status+json	Information successfully retrieved
304		Enterprise Directory integration status has not changed since the last search. Note: The API client must provide the "plcm-enterprise-directory-status" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-enterprise-directory-status" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to conference templates on the server.
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to retrieve the Enterprise Directory status.

https://localhost:8443/api/rest/config/enterprise-directory/delegate-authentication

Methods

GET

Retrieves the current Enterprise Directory delegate authentication settings. [tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-enterprise-directory-delegate-authentication+xml application/vnd.plcm.plcm-enterprise-directory-delegate-authentication+json	Information successfully retrieved
304		Enterprise Directory delegate authentication has not changed since the last search. Note: The API client must provide the "plcm-enterprise-directory-delegate-authentication" representation's ETag value in the "If-None-Match" HTTP header to ensure conditional retrieval. This will improve network performance by reducing bandwidth consumption. If the API client chooses to exclude an ETag value from a previous, identical search in the "If-None-Match" header, then the HTTP response will contain the search results in the message body. The "plcm-enterprise-directory-delegate-authentication" ETag can be accessed from the initial search result's HTTP response header. Also, subsequent searches require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes on the server.
403	application/vnd.plcm.plcm-error+xml	User does not have the correct permission to get the Enterprise Directory delegate authentication settings.

PUT

Update the current Enterprise Directory delegate authentication settings. [tags: DMA]

Request

Representations

application/vnd.plcm.plcm-enterprise-directory-delegate-authentication+xml

application/vnd.plcm.plcm-enterprise-directory-delegate-authentication+json

Response

Status	Representation	Description
204		The update of the settings was successful.
412	application/vnd.plcm.plcm-error+xml	The enterprise directory resource has changed on the server. Note: The response will contain the ETag value. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-enterprise-directory-delegate-authentication.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.
428	application/vnd.plcm.plcm-error+xml	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-enterprise-directory-delegate-authentication.xsd" for details. If the message body does not contain the ETag value, the server will look for the ETag in the "If-Match" header.