Search documentation
karat

+

K

User Documentation ↗
Version 2.0

List Authentication Providers

GET/api/v2/admin/enrollments/{enrollmentRid}/authenticationProviders
Warning

This endpoint is in preview and may be modified or removed at any time. To use this endpoint, add preview=true to the request query parameters.

Lists all AuthenticationProviders.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:admin-read.

Path parameters

enrollmentRid
string

Query parameters

preview
booleanoptional

Enables the use of preview functionality.

Response body

ListAuthenticationProvidersResponse
object
Hide child attributes

Hide child attributes

data
list<AuthenticationProvider>optional
Show child attributes

Show child attributes

Examples

Request

Copied!
1 2 3 curl \ \t-H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/admin/enrollments/ri.control-panel.main.customer.466f812b-f974-4478-9d4f-90402cd3def6/authenticationProviders?preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 { "data": [ { "supportedHosts": [ "example.palantirfoundry.com" ], "name": "Example SAML Provider", "realm": "1bd3813a-ef8b-4211-bfbd-8b6485d0eb83", "rid": "ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86", "enabled": true, "supportedUsernamePatterns": [ ".*@example.com", ".*@palantir.com" ] } ] }

Error responses

Error Name
EnrollmentNotFoundError CodeNOT_FOUND
Status Code404
DescriptionThe given Enrollment could not be found.
ParametersenrollmentRid