PUT /api/auth_source_externals/:id
Update an external authentication source

Examples

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": []
}

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

Validations:

  • Must be an array of any type