Users and Roles - AuthenticationTest List and Create Methods

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test

Supported Methods

GET
POST
GET

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Response

URL Parameters

Required

None.

Optional

ParameterTypeDefault ValueDescription
query string [no filter] The TinyQ language filter that specifies a subset of all available records.
field string not present The name or names of fields whose values are to be returned. The field item may appear zero or more times in the URI query parameters. A single value of "[none]" indicates return only metadata. The absence of any field parameter indicates return all field values,
page integer 1 The 1-based offset into the total records based on page size. Actual offset is (page - 1) * pagesize.
pagesize integer [unlimited] The maximum number of object records to return as a result of the request.

Success Codes

Fault Codes

Response Data

Object type: page
A container for one or more objects in the result listing. There may be multiple pages in a listing if a page size is specified that is less than the total number of objects in the listing.
FieldDescription
nextA URL addressing the subsequent page of objects in the total set of available objects.
objectsThe list of objects returned in the page of results.
prevA URL addressing the previous page of objects in the total set of available objects.
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?page=2&pagesize=1
Sample Response for application/json
Status: 200
{
   "objects":[
      {
         "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"
      }
   ],
   "prev":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test?pagesize=1&page=1"
   },
   "next":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test?pagesize=1&page=3"
   }
}
POST

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

Response

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

Response Data

Object type:
The metadata representation of the newly-created auth-test object, including the URL reference to the new object.
FieldDescription
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
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

POST https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test
{
   "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: 201
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757
{
   "meta":{
      "type":"auth-test",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test/79600390-9B73-102E-A3E2-001676E4A757"
   }
}