Skip to content

Latest commit

 

History

History
248 lines (174 loc) · 7.03 KB

GroupMember.md

File metadata and controls

248 lines (174 loc) · 7.03 KB
Raw

GroupMember

Method HTTP request
add POST /v2/admin/groups/{groupId}/groupMembers/add
list GET /v2/admin/groups/{groupId}/groupMembers
page GET /v2/admin/groups/{groupId}/groupMembers
remove POST /v2/admin/groups/{groupId}/groupMembers/remove

add

Parameters

Name Type Description Notes
group_id PrincipalId groupId
principal_ids List[PrincipalId]
expiration Optional[GroupMembershipExpiration] [optional]

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 | groupId
group_id = None
# List[PrincipalId] |
principal_ids = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]
# Optional[GroupMembershipExpiration] |
expiration = None


try:
    api_response = foundry_client.admin.Group.GroupMember.add(
        group_id,
        principal_ids=principal_ids,
        expiration=expiration,
    )
    print("The add response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling GroupMember.add: %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]

list

Lists all GroupMembers.

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
group_id PrincipalId groupId
page_size Optional[PageSize] pageSize [optional]
transitive Optional[pydantic.StrictBool] transitive [optional]

Return type

ResourceIterator[GroupMember]

Example

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

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

# PrincipalId | groupId
group_id = None
# Optional[PageSize] | pageSize
page_size = None
# Optional[pydantic.StrictBool] | transitive
transitive = None


try:
    for group_member in foundry_client.admin.Group.GroupMember.list(
        group_id,
        page_size=page_size,
        transitive=transitive,
    ):
        pprint(group_member)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling GroupMember.list: %s\n" % e)

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListGroupMembersResponse application/json

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

page

Lists all GroupMembers.

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
group_id PrincipalId groupId
page_size Optional[PageSize] pageSize [optional]
page_token Optional[PageToken] pageToken [optional]
transitive Optional[pydantic.StrictBool] transitive [optional]

Return type

ListGroupMembersResponse

Example

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

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

# PrincipalId | groupId
group_id = None
# Optional[PageSize] | pageSize
page_size = None
# Optional[PageToken] | pageToken
page_token = None
# Optional[pydantic.StrictBool] | transitive
transitive = None


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

Authorization

See README

HTTP response details

Status Code Type Description Content Type
200 ListGroupMembersResponse application/json

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

remove

Parameters

Name Type Description Notes
group_id PrincipalId groupId
principal_ids List[PrincipalId]

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 | groupId
group_id = None
# List[PrincipalId] |
principal_ids = ["f05f8da4-b84c-4fca-9c77-8af0b13d11de"]


try:
    api_response = foundry_client.admin.Group.GroupMember.remove(
        group_id,
        principal_ids=principal_ids,
    )
    print("The remove response:\n")
    pprint(api_response)
except foundry.PalantirRPCException as e:
    print("HTTP error when calling GroupMember.remove: %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]