Login Policy

[tags: DMA]

Resource Root

https://localhost:8443/api/rest/login-policy

Summary

Resources	Methods
https://localhost:8443/api/rest/login-policy
https://localhost:8443/api/rest/login-policy/password-config	GET Retrieves system's local password policy. PUT Updates local password policy.
https://localhost:8443/api/rest/login-policy/login-session-config	GET Retrieve system's login session policy. PUT Update login session policy.
https://localhost:8443/api/rest/login-policy/account-config	GET Retrieve system's local user account policy. PUT Update local user account policy.
https://localhost:8443/api/rest/login-policy/login-banner-config	GET Retrieve system's login banner policy. PUT Update login banner policy.
https://localhost:8443/api/rest/login-policy/whitelist-config	GET Retrieve system's whitelist config. PUT Update Whitelist settings.
https://localhost:8443/api/rest/login-policy/allow-list-config	GET Retrieve system's allow list config. PUT Update allow list settings.

Resources

https://localhost:8443/api/rest/login-policy

https://localhost:8443/api/rest/login-policy/password-config

Methods

GET

Retrieves system's local password policy.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-local-password-config+xml application/vnd.plcm.plcm-local-password-config+json	Local password policy retrieved successfully.
304		Local password policy has not changed since the last retrieval. Note: The API client must provide the "plcm-local-password-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-local-password-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to local password policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Updates local password policy.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-local-password-config+xml

application/vnd.plcm.plcm-local-password-config+json

Response

Status	Representation	Description
204		Local password policy updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid configuration.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-local-password-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-local-password-config.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/login-policy/login-session-config

Methods

GET

Retrieve system's login session policy.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-login-session-config+xml application/vnd.plcm.plcm-login-session-config+json	Login session policy retrieved successfully.
304		Login session policy has not changed since the last retrieval. Note: The API client must provide the "plcm-login-session-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-login-session-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to login session policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Update login session policy.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-login-session-config+xml

application/vnd.plcm.plcm-login-session-config+json

Response

Status	Representation	Description
204		Login session policy updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid configuration.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-login-session-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-login-session-config.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/login-policy/account-config

Methods

GET

Retrieve system's local user account policy.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-local-user-account-config+xml application/vnd.plcm.plcm-local-user-account-config+json	Local user account policy retrieved successfully.
304		Local user account policy has not changed since the last retrieval. Note: The API client must provide the "plcm-local-user-account-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-local-user-account-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to local user account policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Update local user account policy.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-local-user-account-config+xml

application/vnd.plcm.plcm-local-user-account-config+json

Response

Status	Representation	Description
204		Local user account policy updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Invalid configuration.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-local-user-account-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-local-user-account-config.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/login-policy/login-banner-config

Methods

GET

Retrieve system's login banner policy.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-login-banner-config+xml application/vnd.plcm.plcm-login-banner-config+json	Login banner policy retrieved successfully.
304		Login banner policy has not changed since the last retrieval. Note: The API client must provide the "plcm-login-banner-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-login-banner-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to login banner policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Update login banner policy.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-login-banner-config+xml

application/vnd.plcm.plcm-login-banner-config+json

Response

Status	Representation	Description
204		Login banner policy updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	'login-banner-enabled' is invalid or null.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	To enable the login banner, you must provide a message.
400	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The login banner attribute 'message', exceeds the maximum length.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-login-banner-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-login-banner-config.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/login-policy/whitelist-config

Methods

GET

Retrieve system's whitelist config.

NOTE :: This api has been deprecated and will be removed in a future release. Please use getAllowListConfig instead.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-whitelist-config+xml application/vnd.plcm.plcm-whitelist-config+json	Access policy settings retrieved successfully.
304		Whitelist has not changed since the last retrieval. Note: The API client must provide the "plcm-whitelist-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-whitelist-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to login access policy settings policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Update Whitelist settings.

NOTE :: This api has been deprecated and will be removed in a future release. Please use updateAllowListConfig instead.
Support for this object version will be removed in a future release.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-whitelist-config+xml

application/vnd.plcm.plcm-whitelist-config+json

Response

Status	Representation	Description
204		Whitelist updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	'IP address or range' is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	IP address is null.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Whitelist exceeds the maximum length.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-whitelist-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-whitelist-config.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/login-policy/allow-list-config

Methods

GET

Retrieve system's allow list config.
[tags: DMA]

Request

Response

Status	Representation	Description
200	application/vnd.plcm.plcm-allow-list-config+xml application/vnd.plcm.plcm-allow-list-config+json	Access policy settings retrieved successfully.
304		Allow list has not changed since the last retrieval. Note: The API client must provide the "plcm-allow-list-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 retrieval in the "If-None-Match" header, then the HTTP response will contain the retrieval result in the message body. The "plcm-allow-list-config" ETag can be accessed from the initial retrieval result's HTTP response header. Also, subsequent retrievals require the identical search filter to ensure an equivalent ETag value. This also assumes no other client made changes to login access policy settings policy on the server.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.

PUT

Update allow list settings.
[tags: DMA]

Request

Representations

application/vnd.plcm.plcm-allow-list-config+xml

application/vnd.plcm.plcm-allow-list-config+json

Response

Status	Representation	Description
204		Allow list updated successfully. Note: The response will contain an ETag value of the updated resource.
403	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Unable to get permission. User roles required: administrator.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	'IP address or range' is invalid.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	IP address is null.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	Allow list exceeds the maximum length.
409	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The request contains ETags in both the header and the body and they do not match.
412	application/vnd.plcm.plcm-error+xml application/vnd.plcm.plcm-error+json	The resource has changed on the server. Note: The response will contain the ETag value that reflects the server's resource in the HTTP response header. The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-allow-list-config.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 application/vnd.plcm.plcm-error+json	The API client must supply the ETag in the message body that is bounded by the "entity-tag" XML tag. Refer to the "plcm-allow-list-config.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.