Get Identity Pool (Server-only)

GET {{baseUrl}}/api/-/authn-service/identity-pools/:uuid

Get information about an identity pool.

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

HEADERS

KeyDatatypeRequiredDescription
X-Tableau-AuthstringThe 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.
Acceptstring

RESPONSES

status: OK

{"pool":{"identity_pool_id":{"value":"\u003cstring\u003e"},"identity_pool_name":"\u003cstring\u003e","identity_store_instance_id":"\u003cinteger\u003e","auth_type_instance_id":"\u003cinteger\u003e","is_enabled":"\u003cboolean\u003e","created_at":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","description":"\u003cstring\u003e","identity_store_type":"ACTIVE_DIRECTORY","auth_type":"OIDC"}}