Users and Roles - AuthenticationTest Retrieve, Update, and Delete Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/{Id}

Supported Methods

GET
PUT
DELETE
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

None.

Success Codes

Fault Codes

Response Data

Object type: auth-test
An AuthenticationTest object is used by an administrator to test the configuration of an authentication source. Typically this is used to validate LDAP settings and parameters when using an external LDAP directory as an authentication source for the Sentinel system.
FieldDescription
auth-configThe URL of the AuthenticationConfig object that is to be tested.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
passwordThe password value that is to be used in testing the authentication configuration.
userThe name of the user account that is to be used in testing the authentication configuration.
Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldDescription
@hrefThe URL reference to the object.
typeThe name of the object type

Sample Request

GET https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "meta":{
      "type":"auth-test",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757"
   },
   "auth-config":"https://localhost:8443/SentinelRESTServices/objects/auth-config/100D0770-ACA9-102E-809B-001676E4A757",
   "password":"p@$$w0rd",
   "user":"jdoe"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

URL Parameters

None.

Success Codes

Fault Codes

Request Data

Object type: auth-test
An AuthenticationTest object is used by an administrator to test the configuration of an authentication source. Typically this is used to validate LDAP settings and parameters when using an external LDAP directory as an authentication source for the Sentinel system.
FieldRequiredDescription
auth-configtrueThe URL of the AuthenticationConfig object that is to be tested.
passwordtrueThe password value that is to be used in testing the authentication configuration.
usertrueThe name of the user account that is to be used in testing the authentication configuration.

Object type: meta
The metadata for an object, including the object type name and the URL reference to the object.
FieldRequiredDescription
@hreffalseThe URL reference to the object.
typefalseThe name of the object type

Sample Request

PUT https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757
{
   "auth-config":"https://localhost:8443/SentinelRESTServices/objects/auth-config/100D0770-ACA9-102E-809B-001676E4A757",
   "password":"p@$$w0rd",
   "user":"jdoe"
}
Sample Response for application/json
Status: 200

DELETE

Authentication

Authentication Types
Sentinel Permissions Needed

URL Parameters

None.

Success Codes

Fault Codes

Sample Request

DELETE https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757