Hub 2017.2 Help

Get All Auth Modules


GET <REST API URL>/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 subset.
$skip Optional query parameter. Number of roles to skip before returning first entry of the page.
$top Optional query parameter. Max number of roles to return in the page.

Filter query. See Query Syntax for the definition of supported logical operations syntax. Following fields and tuples are supported for AuthModules:

has: user — Auth providers that have associated users

id: value — Auth provider with the given id

is: disabled — All disabled auth providers

name: authModuleName — Auth provider with the given name

serverUrl: authModuleServerUrl — Auth Modules that have given serverUrl

type: authModuleType — Auth providers of the given type

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

orderBy Order results. See Sorting Syntax for details. Roles can be ordered by the following fields: ordinal, name


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


{ "skip": int, "top": int, "total": int, "authmodules": [authmodule, ...] }
Last modified: 19 July 2017