GET /api/auth_sources
List all authentication sources

GET /api/locations/:location_id/auth_sources
List all authentication sources per location

GET /api/organizations/:organization_id/auth_sources
List all authentication sources per organization

Examples

GET /api/auth_sources
200
{
  "total": 3,
  "subtotal": 3,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "created_at": "2022-09-06 14:53:11 UTC",
      "updated_at": "2022-09-06 14:53:11 UTC",
      "id": 980190962,
      "type": "AuthSourceLdap",
      "name": "ldap-server",
      "locations": [
        {
          "id": 255093256,
          "name": "Location 1",
          "title": "Location 1",
          "description": null
        }
      ],
      "organizations": [
        {
          "id": 447626438,
          "name": "Organization 1",
          "title": "Organization 1",
          "description": null
        }
      ]
    },
    {
      "created_at": "2022-09-06 14:53:11 UTC",
      "updated_at": "2022-09-06 14:53:11 UTC",
      "id": 200482051,
      "type": "AuthSourceInternal",
      "name": "Internal",
      "locations": [],
      "organizations": []
    },
    {
      "created_at": "2022-09-06 14:53:11 UTC",
      "updated_at": "2022-09-06 14:53:11 UTC",
      "id": 408068537,
      "type": "AuthSourceExternal",
      "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 and order by a searchable field, e.g. '<field> 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, 'all' to return all results

Validations:

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

Search fields

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