User

Method	HTTP request
delete	DELETE /v2/admin/users/{userId}
get	GET /v2/admin/users/{userId}
get_batch	POST /v2/admin/users/getBatch
get_current	GET /v2/admin/users/getCurrent
list	GET /v2/admin/users
page	GET /v2/admin/users
profile_picture	GET /v2/admin/users/{userId}/profilePicture
search	POST /v2/admin/users/search

delete

Delete the User with the specified id.

Parameters

Name	Type	Description	Notes
user_id	PrincipalId	userId

Return type

None

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# PrincipalId | userId
user_id = None


try:
    api_response = foundry_client.admin.User.delete(
        user_id,
    )
    print("The delete response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.delete: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
204	None		None

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

get

Get the User with the specified id.

Parameters

Name	Type	Description	Notes
user_id	PrincipalId	userId

Return type

User

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# PrincipalId | userId
user_id = None


try:
    api_response = foundry_client.admin.User.get(
        user_id,
    )
    print("The get response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.get: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	User		application/json

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

get_batch

Execute multiple get requests on User.

The maximum batch size for this endpoint is 500.

Parameters

Name	Type	Description	Notes
body	Annotated[List[GetUsersBatchRequestElementDict], Len(min_length=1, max_length=500)]	Body of the request

Return type

GetUsersBatchResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# Annotated[List[GetUsersBatchRequestElementDict], Len(min_length=1, max_length=500)] | Body of the request
body = [{"userId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}]


try:
    api_response = foundry_client.admin.User.get_batch(
        body,
    )
    print("The get_batch response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.get_batch: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	GetUsersBatchResponse		application/json

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

get_current

Parameters

Name	Type	Description	Notes

Return type

User

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)


try:
    api_response = foundry_client.admin.User.get_current()
    print("The get_current response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.get_current: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	User		application/json

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

Retrieve Markings that the user is currently a member of.

Parameters

Name	Type	Description	Notes
user_id	PrincipalId	userId
preview	Optional[PreviewMode]	preview	[optional]

Return type

GetUserMarkingsResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# PrincipalId | userId
user_id = None
# Optional[PreviewMode] | preview
preview = None


try:
    api_response = foundry_client.admin.User.get_markings(
        user_id,
        preview=preview,
    )
    print("The get_markings response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.get_markings: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	GetUserMarkingsResponse		application/json

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

list

Lists all Users.

This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the nextPageToken field will be populated. To get the next page, make the same request again, but set the value of the pageToken query parameter to be value of the nextPageToken value of the previous response. If there is no nextPageToken field in the response, you are on the last page.

Parameters

Name	Type	Description	Notes
page_size	Optional[PageSize]	pageSize	[optional]
page_token	Optional[PageToken]	pageToken	[optional]

Return type

ResourceIterator[User]

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None


try:
    for user in foundry_client.admin.User.list(
        page_size=page_size,
        page_token=page_token,
    ):
        pprint(user)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.list: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ListUsersResponse		application/json

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

page

Lists all Users.

This is a paged endpoint. Each page may be smaller or larger than the requested page size. However, it is guaranteed that if there are more results available, the nextPageToken field will be populated. To get the next page, make the same request again, but set the value of the pageToken query parameter to be value of the nextPageToken value of the previous response. If there is no nextPageToken field in the response, you are on the last page.

Parameters

Name	Type	Description	Notes
page_size	Optional[PageSize]	pageSize	[optional]
page_token	Optional[PageToken]	pageToken	[optional]

Return type

ListUsersResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None


try:
    api_response = foundry_client.admin.User.page(
        page_size=page_size,
        page_token=page_token,
    )
    print("The page response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.page: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	ListUsersResponse		application/json

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

profile_picture

Parameters

Name	Type	Description	Notes
user_id	PrincipalId	userId

Return type

bytes

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# PrincipalId | userId
user_id = None


try:
    api_response = foundry_client.admin.User.profile_picture(
        user_id,
    )
    print("The profile_picture response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.profile_picture: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	bytes	The user's profile picture in binary format. The format is the original format uploaded by the user. The response will contain a `Content-Type` header that can be used to identify the media type.	application/octet-stream

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

search

Parameters

Name	Type	Notes
where	UserSearchFilterDict
page_size	Optional[PageSize]	[optional]
page_token	Optional[PageToken]	[optional]

Return type

SearchUsersResponse

Example

from foundry.v2 import FoundryClient
import foundry
from pprint import pprint

foundry_client = FoundryClient(
    auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com"
)

# UserSearchFilterDict |
where = {"type": "queryString"}
# Optional[PageSize] |
page_size = 100
# Optional[PageToken] |
page_token = "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z"


try:
    api_response = foundry_client.admin.User.search(
        where=where,
        page_size=page_size,
        page_token=page_token,
    )
    print("The search response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling User.search: %s\n" % e)

Authorization

See README

HTTP response details

Status Code	Type	Description	Content Type
200	SearchUsersResponse		application/json

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

Files

User.md

Latest commit

History

User.md

File metadata and controls

User

delete

Parameters

Return type

Example

Authorization

HTTP response details

get

Parameters

Return type

Example

Authorization

HTTP response details

get_batch

Parameters

Return type

Example

Authorization

HTTP response details

get_current

Parameters

Return type

Example

Authorization

HTTP response details

Parameters

Return type

Example

Authorization

HTTP response details

list

Parameters

Return type

Example

Authorization

HTTP response details

page

Parameters

Return type

Example

Authorization

HTTP response details

profile_picture

Parameters

Return type

Example

Authorization

HTTP response details

search

Parameters

Return type

Example

Authorization

HTTP response details