Get All Auth Modules
Request
GET /authmodules?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter | Description |
---|---|
fields | Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define the subset. |
$skip | Optional query parameter. Number of auth modules to skip before returning the first entry in the page. |
$top | Optional query parameter. Maximum number of auth modules to return in the page. |
query | Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for auth modules: id: value — Auth provider with the given id name: authModuleName — Auth provider with the given name is: disabled — All disabled auth providers user: user — All auth providers that provide user details for the given user has: user — Auth providers that have associated users type: authModuleType — Auth providers of the given type serverUrl: authModuleServerUrl — Auth Modules that have given serverUrl |
orderBy | Order results. See Sorting Syntax for details. Auth modules can be ordered by the following fields: ordinal, name |
Response
Response Code | Meaning |
---|---|
200 OK | Successful request. |
400 Bad Request | Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error. |
403 Forbidden | Requester has no access to the request. |
404 Not Found | Requested resource wasn't found. |
500 Internal Server Error | Failed to process request because of the server error. The response contains message describing the error. |
Response body
page
{
"skip": int, /* Requested number of auth modules to skip before returning the first entry in the page */
"top": int, /* Requested maximum number of auth modules to return in the page */
"total": int, /* Total number of auth modules. Returned only if the total field is included as a value of the fields parameter in the query */
"authmodules": [authmodule, ...]
}
Last modified: 19 April 2016