Update Authentication Configuration (Server-only)
PUT {{baseUrl}}/api/-/authn-service/auth-configurations/:id
Update an authentication instance.
Note: The request body must specify all the required and desired parameters, not jus the parameters you want to update.
Version: Available in API 3.19 (Tableau Server 2023.1) and later. Not available for Tableau Cloud. Versioning Overview
Permissions: This method can only be called by users with server administrator permissions. Permissions Overview
License: No additional license required.
Access Scope: Not available.
Access Scopes Overview: Server-Windows | Server-Linux
Request Body
{"id"=>"<integer>", "auth_type"=>"OIDC", "iframed_idp_enabled"=>"<boolean>", "oidc"=>{"client_id"=>"<string>", "client_secret"=>"<string>", "config_url"=>"<string>", "custom_scope"=>"<string>", "id_claim"=>"<string>", "username_claim"=>"<string>", "client_authentication"=>"<string>", "essential_acr_values"=>"<string>", "voluntary_acr_values"=>"<string>", "prompt"=>"<string>", "connection_timeout"=>"<integer>", "read_timeout"=>"<integer>", "ignore_domain"=>"<boolean>", "ignore_jwk"=>"<boolean>"}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-Tableau-Auth | string | The Tableau authentication header. The value is a credentials token from a Tableau server's response to an authentication request. | |
| The Content-Type and Accept headers should be the mediatype of the request and response except in cases where you want to explicitly allow other versions of the resource. | |||
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"auth_configuration":{"id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","auth_type":"OIDC","iframed_idp_enabled":"\u003cboolean\u003e","oidc":{"client_id":"\u003cstring\u003e","client_secret":"\u003cstring\u003e","config_url":"\u003cstring\u003e","custom_scope":"\u003cstring\u003e","id_claim":"\u003cstring\u003e","username_claim":"\u003cstring\u003e","client_authentication":"\u003cstring\u003e","essential_acr_values":"\u003cstring\u003e","voluntary_acr_values":"\u003cstring\u003e","prompt":"\u003cstring\u003e","connection_timeout":"\u003cinteger\u003e","read_timeout":"\u003cinteger\u003e","ignore_domain":"\u003cboolean\u003e","ignore_jwk":"\u003cboolean\u003e"}}}