Users and Roles - AuthenticationConfig List and Create Methods

URI

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

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-config
An AuthenticationConfig object contains information about an authentication source and its configuration. An authentication source is used by Sentinel to validate a user's credentials when the user logs into the Sentinel system.
FieldDescription
certThe URL of the server certificate for TLS-protected LDAP authentication, if any.
metaThe metadata for an object, including the object type name and the URL reference to the object. Definition
propertiesA collection of name-value pairs that are specific to the authentication configuration type.
testTrue if the AuthenticationConfig object exists for the purpose of testing.
typeThe type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory.
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-config?page=2&pagesize=1
Sample Response for application/json
Status: 200
{
   "objects":[
      {
         "meta":{
            "type":"auth-config",
            "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/79600390-9B73-102E-A3E2-001676E4A757"
         },
         "cert":{
            "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/79600390-9B73-102E-A3E2-001676E4A757/cert"
         },
         "test":true,
         "properties":[
            {
               "key":"port",
               "value":"636"
            },
            {
               "key":"useSSL",
               "value":"true"
            },
            {
               "key":"10.0.1.123",
               "value":"host"
            },
            {
               "key":"base-dn",
               "value":"cn=users,dc=office,dc=acme,dc=com"
            },
            {
               "key":"search-attr",
               "value":"sAMAccountName"
            }
         ],
         "type":"LDAP"
      }
   ],
   "prev":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config?pagesize=1&page=1"
   },
   "next":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config?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-config
An AuthenticationConfig object contains information about an authentication source and its configuration. An authentication source is used by Sentinel to validate a user's credentials when the user logs into the Sentinel system.
FieldRequiredDescription
certfalseThe URL of the server certificate for TLS-protected LDAP authentication, if any.
propertiesfalseA collection of name-value pairs that are specific to the authentication configuration type.
testfalseTrue if the AuthenticationConfig object exists for the purpose of testing.
typefalseThe type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory.

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-config 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-config
{
   "cert":{
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/79600390-9B73-102E-A3E2-001676E4A757/cert"
   },
   "test":true,
   "properties":[
      {
         "key":"port",
         "value":"636"
      },
      {
         "key":"useSSL",
         "value":"true"
      },
      {
         "key":"10.0.1.123",
         "value":"host"
      },
      {
         "key":"base-dn",
         "value":"cn=users,dc=office,dc=acme,dc=com"
      },
      {
         "key":"search-attr",
         "value":"sAMAccountName"
      }
   ],
   "type":"LDAP"
}
Sample Response for application/json
Status: 201
Location:https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/79600390-9B73-102E-A3E2-001676E4A757
{
   "meta":{
      "type":"auth-config",
      "@href":"https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/79600390-9B73-102E-A3E2-001676E4A757"
   }
}