Hub 2018.3 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. Returns only the specified subset of the fields for each AuthModule. Use Fields Syntax to define the subset.

$skip

Optional. Lets you set a number of AuthModules to skip before returning the first one.

$top

Optional. Lets you set the maximum number of AuthModules to return.

query

Optional. Lets you specify a search query to 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. Returns the list of AuthModules sorted by a specified field. 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

At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.

403 Forbidden

The requester has no access to the requested resource.

404 Not Found

The requested resource was not found.

500 Internal Server Error

Failed to process request because of the server error. For details, check the error message in the response.

Response body

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