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

Примеры

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": "2019-11-07 08:44:12 UTC",
      "updated_at": "2019-11-07 08:44:12 UTC",
      "id": 408068537,
      "name": "External",
      "locations": [],
      "organizations": []
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Ограничить местоположением

Validations:

  • Must be a Integer

organization_id
необязательно

Ограничить организацией

Validations:

  • Must be a Integer

search
необязательно

отфильтровать результаты

Validations:

  • Must be a String

order
необязательно

Sort field and order, eg. ‘id DESC’

Validations:

  • Must be a String

page
необязательно

Номер страницы, начиная с 1

Validations:

  • Must be a number.

per_page
необязательно

Число элементов на странице

Validations:

  • Must be a number.


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

Примеры

GET /api/auth_source_externals/408068537
200
{
  "created_at": "2019-11-07 08:44:12 UTC",
  "updated_at": "2019-11-07 08:44:12 UTC",
  "id": 408068537,
  "name": "External",
  "external_usergroups": [],
  "locations": [
    {
      "id": 255093256,
      "name": "Location 1",
      "title": "Location 1",
      "description": null
    }
  ],
  "organizations": [
    {
      "id": 447626438,
      "name": "Organization 1",
      "title": "Organization 1",
      "description": null
    }
  ]
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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

Примеры

PUT /api/auth_source_externals/408068537
{
  "auth_source_external": {
    "name": "new_name_external"
  }
}
200
{
  "created_at": "2019-11-07 08:44:12 UTC",
  "updated_at": "2019-11-07 08:44:20 UTC",
  "id": 408068537,
  "name": "new_name_external",
  "external_usergroups": [],
  "locations": [],
  "organizations": []
}

Параметры

Имя параметра Описание
location_id
необязательно

Set the current location context for the request

Validations:

  • Must be a Integer

organization_id
необязательно

Set the current organization context for the request

Validations:

  • Must be a Integer

id
обязательно

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
обязательно

Validations:

  • Must be a Hash

auth_source_external[name]
необязательно

Validations:

  • Must be a String

auth_source_external[location_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ местоположения с заданным кодом

Validations:

  • Must be an array of any type

auth_source_external[organization_ids]
необязательно , nil разрешен

ЗАМЕСТИТЬ организации с заданным кодом

Validations:

  • Must be an array of any type