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

URI

https://164.99.19.131:8443/SentinelRESTServices/objects/auth-config/{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-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/79600390-9B73-102E-A3E2-001676E4A757
Sample Response for application/json
Status: 200
{
   "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"
}
PUT

Authentication

Authentication Types
Sentinel Permissions Needed

Supported Formats

Request

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

Sample Request

PUT 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"
}
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-config/79600390-9B73-102E-A3E2-001676E4A757