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

Examples

GET /api/auth_source_externals
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2020-05-20 13:18:48 UTC",
      "updated_at": "2020-05-20 13:18:48 UTC",
      "id": 408068537,
      "name": "External",
      "locations": [],
      "organizations": []
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer
organization_id
optional

Scope by organizations

Validations:

  • Must be a Integer
search
optional

filter results

Validations:

  • Must be a String
order
optional

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return

Validations:

  • Must be a number.

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

Examples

GET /api/auth_source_externals/408068537
200
{
  "created_at": "2020-05-20 13:18:48 UTC",
  "updated_at": "2020-05-20 13:18:48 UTC",
  "id": 408068537,
  "name": "External",
  "external_usergroups": [],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
>>>

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

Examples

PUT /api/auth_source_externals/408068537
{
  "auth_source_external": {
    "name": "new_name_external"
  }
}
200
{
  "created_at": "2020-05-20 13:18:48 UTC",
  "updated_at": "2020-05-20 13:18:58 UTC",
  "id": 408068537,
  "name": "new_name_external",
  "external_usergroups": [],
  "locations": [],
  "organizations": []
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
auth_source_external
required

Validations:

  • Must be a Hash
auth_source_external[name]
optional

Validations:

  • Must be a 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