UsersResource

REST end point for manipulating lists of internally managed users and managed users authentication provider enablement.

The following resources are part of this group:

/security/users

Mount Point: /api/security/users

GET

This end point returns the list of all the internally managed administrative users in the application.

Response Body

element: user
media types: application/xml

this end point returns an array of user elements

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/users/canDisableManagedUsers

Mount Point: /api/security/users/canDisableManagedUsers

GET

This end point allows applications to determine whether the internally managed users authentication provider can be disabled or not. The internally managed users provider may only be disabled if other authentication mechanisms (Kerberos or LDAP, for example) are configured.

Response Body

element: (custom)
media types: text/plain

this end point simply returns a boolean value in plain text, "true" or "false"

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/users/disableManagedUsers

Mount Point: /api/security/users/disableManagedUsers

POST

This end point allows an application to disable the internally managed users authentication provider. When disabled, this provider will no longer be consulted during the user authentication process. Once disabled, the internally managed user provider may not be enabled again through the REST API, it can only be re-enabled by using the security reset command line utility.

Status Codes

code description
202 Accepted
400 Bad request - See exception
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error

/security/users/isManagedUsersDisabled

Mount Point: /api/security/users/isManagedUsersDisabled

GET

This end point allows applications to determine whether the internally managed users authentication provider is currently disabled or not. If enabled, this provider will be consulted first, ahead of any configured Kerberos or LDAP providers when a user is being authenticated.

Response Body

element: (custom)
media types: text/plain

this end point simply returns a boolean value in plain text, "true" or "false"

Status Codes

code description
200 Ok
401 Authentication required
403 Authorization required - access forbidden
500 Internal server error