Parameter | Type | Default Value | Description |
---|---|---|---|
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. |
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. | |
Field | Description |
next | A URL addressing the subsequent page of objects in the total set of available objects. |
objects | The list of objects returned in the page of results. |
prev | A 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. | |
Field | Description |
auth-config | The URL of the AuthenticationConfig object that is to be tested. |
meta | The metadata for an object, including the object type name and the URL reference to the object. Definition |
password | The password value that is to be used in testing the authentication configuration. |
user | The 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. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
GET https://164.99.19.131:8443/SentinelRESTServices/objects/auth-test?page=2&pagesize=1
{ "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" } }
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. | ||
Field | Required | Description |
auth-config | true | The URL of the AuthenticationConfig object that is to be tested. |
password | true | The password value that is to be used in testing the authentication configuration. |
user | true | The 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. | ||
Field | Required | Description |
@href | false | The URL reference to the object. |
type | false | The name of the object type |
Object type: | |
---|---|
The metadata representation of the newly-created auth-test object, including the URL reference to the new object. | |
Field | Description |
meta | The 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. | |
Field | Description |
@href | The URL reference to the object. |
type | The name of the object type |
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" }
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" } }