Skip to content

Latest commit

 

History

History
278 lines (204 loc) · 9.43 KB

AuthenticationProvider.md

File metadata and controls

278 lines (204 loc) · 9.43 KB

AuthenticationProvider

Method HTTP request Release Stage
get GET /v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid} Public Beta
list GET /v2/admin/enrollments/{enrollmentRid}/authenticationProviders Public Beta
preregister_group POST /v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid}/preregisterGroup Public Beta
preregister_user POST /v2/admin/enrollments/{enrollmentRid}/authenticationProviders/{authenticationProviderRid}/preregisterUser Public Beta

get

Get the AuthenticationProvider with the specified rid.

Parameters

Name Type Description Notes
enrollment_rid EnrollmentRid
authentication_provider_rid AuthenticationProviderRid
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

AuthenticationProvider

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EnrollmentRid
enrollment_rid = None
# AuthenticationProviderRid
authentication_provider_rid = "ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.admin.Enrollment.AuthenticationProvider.get(
        enrollment_rid, authentication_provider_rid, preview=preview
    )
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling AuthenticationProvider.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 AuthenticationProvider application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

list

Lists all AuthenticationProviders.

Parameters

Name Type Description Notes
enrollment_rid EnrollmentRid
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

ListAuthenticationProvidersResponse

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EnrollmentRid
enrollment_rid = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.admin.Enrollment.AuthenticationProvider.list(
        enrollment_rid, preview=preview
    )
    print("The list response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling AuthenticationProvider.list: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListAuthenticationProvidersResponse application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preregister_group

Register a Group with a given name before any users with this group log in through this Authentication Provider. Preregistered groups can be used anywhere other groups are used in the platform.

Parameters

Name Type Description Notes
enrollment_rid EnrollmentRid
authentication_provider_rid AuthenticationProviderRid
name GroupName
organizations List[OrganizationRid] The RIDs of the Organizations that can view this group.
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

PrincipalId

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EnrollmentRid
enrollment_rid = None
# AuthenticationProviderRid
authentication_provider_rid = "ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86"
# GroupName
name = "Data Source Admins"
# List[OrganizationRid] | The RIDs of the Organizations that can view this group.
organizations = ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"]
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.admin.Enrollment.AuthenticationProvider.preregister_group(
        enrollment_rid,
        authentication_provider_rid,
        name=name,
        organizations=organizations,
        preview=preview,
    )
    print("The preregister_group response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling AuthenticationProvider.preregister_group: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 PrincipalId application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

preregister_user

Register a User with a given username before they log in to the platform for the first time through this Authentication Provider. Preregistered users can be assigned to groups and roles prior to first login.

Parameters

Name Type Description Notes
enrollment_rid EnrollmentRid
authentication_provider_rid AuthenticationProviderRid
organization OrganizationRid The RID of the user's primary Organization. This may be changed when the user logs in for the first time depending on any configured Organization assignment rules.
username UserUsername The new user's username. This must match one of the provider's supported username patterns.
attributes Optional[Dict[AttributeName, AttributeValues]] [optional]
email Optional[str] [optional]
family_name Optional[str] [optional]
given_name Optional[str] [optional]
preview Optional[PreviewMode] Enables the use of preview functionality. [optional]

Return type

PrincipalId

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.palantirfoundry.com")

# EnrollmentRid
enrollment_rid = None
# AuthenticationProviderRid
authentication_provider_rid = "ri.control-panel.main.saml.3faf689c-eaa1-4137-851f-81d58afe4c86"
# OrganizationRid | The RID of the user's primary Organization. This may be changed when the user logs in for the first time depending on any configured Organization assignment rules.
organization = "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
# UserUsername | The new user's username. This must match one of the provider's supported username patterns.
username = "jsmith"
# Optional[Dict[AttributeName, AttributeValues]]
attributes = {
    "multipass:givenName": ["John"],
    "multipass:familyName": ["Smith"],
    "multipass:email:primary": ["jsmith@example.com"],
    "multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"],
    "multipass:organization-rid": [
        "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
    ],
    "department": ["Finance"],
    "jobTitle": ["Accountant"],
}
# Optional[str]
email = "jsmith@example.com"
# Optional[str]
family_name = "Smith"
# Optional[str]
given_name = "John"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
    api_response = client.admin.Enrollment.AuthenticationProvider.preregister_user(
        enrollment_rid,
        authentication_provider_rid,
        organization=organization,
        username=username,
        attributes=attributes,
        email=email,
        family_name=family_name,
        given_name=given_name,
        preview=preview,
    )
    print("The preregister_user response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling AuthenticationProvider.preregister_user: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 PrincipalId application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]