Examples

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
    }
  ]
}

Params

Param name Description
location_id
optional

Scope by locations

Validations:

  • Must be a Integer

organization_id
optional

Scope by organisations

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 organisations with given ids.

Validations:

  • Must be an array of any type