Auth source externals

>>>

GET /api/auth_source_externals
List external authentication sources

GET /api/locations/:location_id/auth_source_externals
List external authentication sources per location

GET /api/organizations/:organization_id/auth_source_externals
List external authentication sources per organization

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Integer
organization_id
optional

Scope by organizations

Validations:

  • Integer
search
optional

filter results

Validations:

  • String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, ‘all’ to return all results

Validations:

  • Must match regular expression /\A([1-9]\d|all)\Z$/.

Search fields

Field name Type Possible values
location string
location_id integer
name string
organization string
organization_id integer
>>>

GET /api/auth_source_externals/:id
Show an external authentication source

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
>>>

PUT /api/auth_source_externals/:id
Update an external authentication source

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, ‘‘, ‘-’ with no leading or trailing space..
auth_source_external
required

Validations:

  • Hash
auth_source_external[name]
optional

Validations:

  • String
auth_source_external[location_ids]
optional , nil allowed

REPLACE locations with given ids

Validations:

  • Must be an array of any type
auth_source_external[organization_ids]
optional , nil allowed

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type