-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
c111cd7
commit daafbb2
Showing
33 changed files
with
1,270 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| # ResourceRole | ||
|
|
||
| Method | HTTP request | | ||
| ------------- | ------------- | | ||
|
|
||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **resource_rid** | ResourceRid | resourceRid | | | ||
| **roles** | List[ResourceRoleDict] | | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **None** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceRid | resourceRid | ||
| resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" | ||
| # List[ResourceRoleDict] | | ||
| roles = [{"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"}] | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Resource.ResourceRole.add( | ||
| resource_rid, | ||
| roles=roles, | ||
| preview=preview, | ||
| ) | ||
| print("The add response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling ResourceRole.add: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **204** | None | | None | | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) | ||
|
|
||
| List the roles on a resource. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **resource_rid** | ResourceRid | resourceRid | | | ||
| **include_inherited** | Optional[bool] | includeInherited | [optional] | | ||
| **page_size** | Optional[PageSize] | pageSize | [optional] | | ||
| **page_token** | Optional[PageToken] | pageToken | [optional] | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **ResourceIterator[ResourceRole]** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceRid | resourceRid | ||
| resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" | ||
| # Optional[bool] | includeInherited | ||
| include_inherited = None | ||
| # Optional[PageSize] | pageSize | ||
| page_size = None | ||
| # Optional[PageToken] | pageToken | ||
| page_token = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| for resource_role in foundry_client.filesystem.Resource.ResourceRole.list( | ||
| resource_rid, | ||
| include_inherited=include_inherited, | ||
| page_size=page_size, | ||
| page_token=page_token, | ||
| preview=preview, | ||
| ): | ||
| pprint(resource_role) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling ResourceRole.list: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | ListResourceRolesResponse | | application/json | | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) | ||
|
|
||
| List the roles on a resource. | ||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **resource_rid** | ResourceRid | resourceRid | | | ||
| **include_inherited** | Optional[bool] | includeInherited | [optional] | | ||
| **page_size** | Optional[PageSize] | pageSize | [optional] | | ||
| **page_token** | Optional[PageToken] | pageToken | [optional] | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **ListResourceRolesResponse** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceRid | resourceRid | ||
| resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" | ||
| # Optional[bool] | includeInherited | ||
| include_inherited = None | ||
| # Optional[PageSize] | pageSize | ||
| page_size = None | ||
| # Optional[PageToken] | pageToken | ||
| page_token = None | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Resource.ResourceRole.page( | ||
| resource_rid, | ||
| include_inherited=include_inherited, | ||
| page_size=page_size, | ||
| page_token=page_token, | ||
| preview=preview, | ||
| ) | ||
| print("The page response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling ResourceRole.page: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **200** | ListResourceRolesResponse | | application/json | | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) | ||
|
|
||
|
|
||
|
|
||
| ### Parameters | ||
|
|
||
| Name | Type | Description | Notes | | ||
| ------------- | ------------- | ------------- | ------------- | | ||
| **resource_rid** | ResourceRid | resourceRid | | | ||
| **roles** | List[ResourceRoleDict] | | | | ||
| **preview** | Optional[PreviewMode] | preview | [optional] | | ||
|
|
||
| ### Return type | ||
| **None** | ||
|
|
||
| ### Example | ||
|
|
||
| ```python | ||
| from foundry.v2 import FoundryClient | ||
| import foundry | ||
| from pprint import pprint | ||
|
|
||
| foundry_client = FoundryClient( | ||
| auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" | ||
| ) | ||
|
|
||
| # ResourceRid | resourceRid | ||
| resource_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" | ||
| # List[ResourceRoleDict] | | ||
| roles = [{"roleId": "8bf49052-dc37-4528-8bf0-b551cfb71268"}] | ||
| # Optional[PreviewMode] | preview | ||
| preview = None | ||
|
|
||
|
|
||
| try: | ||
| api_response = foundry_client.filesystem.Resource.ResourceRole.remove( | ||
| resource_rid, | ||
| roles=roles, | ||
| preview=preview, | ||
| ) | ||
| print("The remove response:\n") | ||
| pprint(api_response) | ||
| except foundry.PalantirRPCException as e: | ||
| print("HTTP error when calling ResourceRole.remove: %s\n" % e) | ||
|
|
||
| ``` | ||
|
|
||
|
|
||
|
|
||
| ### Authorization | ||
|
|
||
| See [README](../../../README.md#authorization) | ||
|
|
||
| ### HTTP response details | ||
| | Status Code | Type | Description | Content Type | | ||
| |-------------|-------------|-------------|------------------| | ||
| **204** | None | | None | | ||
|
|
||
| [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # RoleId | ||
|
|
||
| The unique ID for a Role. Roles are sets of permissions that grant different levels of access to resources. | ||
| The default roles in Foundry are: Owner, Editor, Viewer, and Discoverer. See more about | ||
| [roles](/docs/foundry/security/projects-and-roles#roles) in the user documentation. | ||
|
|
||
|
|
||
| ## Type | ||
| ```python | ||
| str | ||
| ``` | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Everyone | ||
|
|
||
| A principal representing all users of the platform. | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **type** | Literal["everyone"] | Yes | None | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # EveryoneDict | ||
|
|
||
| A principal representing all users of the platform. | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **type** | Literal["everyone"] | Yes | None | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # ListResourceRolesResponse | ||
|
|
||
| ListResourceRolesResponse | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **data** | List[ResourceRole] | Yes | | | ||
| **next_page_token** | Optional[PageToken] | No | | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
12 changes: 12 additions & 0 deletions
12
docs/v2/filesystem/models/ListResourceRolesResponseDict.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| # ListResourceRolesResponseDict | ||
|
|
||
| ListResourceRolesResponse | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **data** | List[ResourceRoleDict] | Yes | | | ||
| **nextPageToken** | NotRequired[PageToken] | No | | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # PrincipalWithId | ||
|
|
||
| Represents a user principal or group principal with an ID. | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **principal_id** | PrincipalId | Yes | | | ||
| **principal_type** | PrincipalType | Yes | | | ||
| **type** | Literal["principalWithId"] | Yes | None | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # PrincipalWithIdDict | ||
|
|
||
| Represents a user principal or group principal with an ID. | ||
|
|
||
| ## Properties | ||
| | Name | Type | Required | Description | | ||
| | ------------ | ------------- | ------------- | ------------- | | ||
| **principalId** | PrincipalId | Yes | | | ||
| **principalType** | PrincipalType | Yes | | | ||
| **type** | Literal["principalWithId"] | Yes | None | | ||
|
|
||
|
|
||
| [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) |
Oops, something went wrong.