GET /api/auth_source_externals
外部認証ソースを一覧表示

GET /api/locations/:location_id/auth_source_externals
場所ごとの外部認証ソースを一覧表示します

GET /api/organizations/:organization_id/auth_source_externals
組織ごとの外部認証ソースを一覧表示します

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-09-11 14:51:18 UTC",
      "updated_at": "2019-09-11 14:51:18 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
任意

フィールドと順序のソート (例: ‘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
外部認証ソースの表示

GET /api/auth_source_externals/408068537
200
{
  "created_at": "2019-09-11 14:51:18 UTC",
  "updated_at": "2019-09-11 14:51:18 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
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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
外部認証ソースの更新

PUT /api/auth_source_externals/408068537
{
  "auth_source_external": {
    "organization_names": [
      "Organization 1"
    ],
    "location_ids": [
      255093256
    ]
  }
}
200
{
  "created_at": "2019-09-11 14:51:18 UTC",
  "updated_at": "2019-09-11 14:51:18 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
任意

ロケーション別のスコープ

Validations:

  • Must be a Integer

organization_id
任意

組織別のスコープ

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可

ロケーションを指定された ID に置き換えます

Validations:

  • Must be an array of any type

auth_source_external[organization_ids]
任意 , nil可

組織を指定された ID に置き換えます。

Validations:

  • Must be an array of any type