Hub 2018.1 Help

Get All Auth Modules

Request

GET <REST API URL>/authmodules?fields=string&$skip=int&$top=int&query=string&orderBy=string
Parameter Description
fields Optional Lets you specify a subset of the fields to be returned. Use Fields Syntax to define the subset.
$skip Optional Lets you set a number of entries to skip before returning the first entry of the page.
$top Optional Lets you set the maximum number of entries to return in the page.
query

Optional Lets you filter the returned results. See Query Syntax for the definition of supported logical operations syntax. For the AuthModules, the following fields and tuples are supported:

has: user — Auth providers that have associated users

id: value — Auth module with the given ID

is: disabled — All disabled auth providers

name: authModuleName — Auth module with the given name

serverUrl: authModuleServerURL — Auth modules with the given server URL

type: authModuleType — Auth modules of the given type

user: user — All auth modules that provide user details for the given user

orderBy Optional Lets you order the returned results. See Sorting Syntax for details. AuthModules support ordering by the following fields: name, ordinal

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 a message that describes the error.
403 Forbidden Requester has no access to the request.
404 Not Found Requested resource was not found.
500 Internal Server Error Failed to process request because of the server error. The response contains a message that describes the error.

Response body

page

{ "skip": int, "top": int, "total": int, "authmodules": [authmodule, ...] }
Last modified: 5 April 2018