Skip to content

Latest commit

 

History

History
105 lines (68 loc) · 2.9 KB

File metadata and controls

105 lines (68 loc) · 2.9 KB

Enrollment

Method HTTP request Release Stage
get GET /v2/admin/enrollments/{enrollmentRid} Public Beta
get_current GET /v2/admin/enrollments/getCurrent Public Beta

get

Get the Enrollment with the specified rid.

Parameters

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

Return type

Enrollment

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.get(enrollment_rid, preview=preview)
    print("The get response:\n")
    pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
    print("HTTP error when calling Enrollment.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Enrollment application/json

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

get_current

Returns the Enrollment associated with the current User's primary organization.

Parameters

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

Return type

Enrollment

Example

from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

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


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

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 Enrollment application/json

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