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 , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE locations with given ids

Validations:

  • Must be an array of any type

auth_source_external[organization_ids]
Optional , <span class="translation_missing" title="translation missing: cs-CZ.apipie.nil_allowed">Nil Allowed</span>

REPLACE organizations with given ids.

Validations:

  • Must be an array of any type