Auth source internals

>>>

GET /api/auth_source_internals
List internal authentication sources

Examples

GET /api/auth_source_internals
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2019-11-07 09:09:40 UTC",
      "updated_at": "2019-11-07 09:09:40 UTC",
      "id": 200482051,
      "name": "Internal"
    }
  ]
}

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
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_internals/:id
Show an internal authentication source

Examples

GET /api/auth_source_internals/200482051
200
{
  "created_at": "2019-11-07 09:09:40 UTC",
  "updated_at": "2019-11-07 09:09:40 UTC",
  "id": 200482051,
  "name": "Internal"
}

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.