Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,7 @@ Namespace | Name | Import |
**Admin** | [ListMarkingMembersResponse](docs/v2/Admin/models/ListMarkingMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingMembersResponse` |
**Admin** | [ListMarkingRoleAssignmentsResponse](docs/v2/Admin/models/ListMarkingRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingRoleAssignmentsResponse` |
**Admin** | [ListMarkingsResponse](docs/v2/Admin/models/ListMarkingsResponse.md) | `from foundry_sdk.v2.admin.models import ListMarkingsResponse` |
**Admin** | [ListOrganizationGuestMembersResponse](docs/v2/Admin/models/ListOrganizationGuestMembersResponse.md) | `from foundry_sdk.v2.admin.models import ListOrganizationGuestMembersResponse` |
**Admin** | [ListOrganizationRoleAssignmentsResponse](docs/v2/Admin/models/ListOrganizationRoleAssignmentsResponse.md) | `from foundry_sdk.v2.admin.models import ListOrganizationRoleAssignmentsResponse` |
**Admin** | [ListUsersResponse](docs/v2/Admin/models/ListUsersResponse.md) | `from foundry_sdk.v2.admin.models import ListUsersResponse` |
**Admin** | [Marking](docs/v2/Admin/models/Marking.md) | `from foundry_sdk.v2.admin.models import Marking` |
Expand All @@ -1043,6 +1044,7 @@ Namespace | Name | Import |
**Admin** | [MarkingType](docs/v2/Admin/models/MarkingType.md) | `from foundry_sdk.v2.admin.models import MarkingType` |
**Admin** | [OidcAuthenticationProtocol](docs/v2/Admin/models/OidcAuthenticationProtocol.md) | `from foundry_sdk.v2.admin.models import OidcAuthenticationProtocol` |
**Admin** | [Organization](docs/v2/Admin/models/Organization.md) | `from foundry_sdk.v2.admin.models import Organization` |
**Admin** | [OrganizationGuestMember](docs/v2/Admin/models/OrganizationGuestMember.md) | `from foundry_sdk.v2.admin.models import OrganizationGuestMember` |
**Admin** | [OrganizationName](docs/v2/Admin/models/OrganizationName.md) | `from foundry_sdk.v2.admin.models import OrganizationName` |
**Admin** | [OrganizationRoleAssignment](docs/v2/Admin/models/OrganizationRoleAssignment.md) | `from foundry_sdk.v2.admin.models import OrganizationRoleAssignment` |
**Admin** | [PreregisterGroupRequest](docs/v2/Admin/models/PreregisterGroupRequest.md) | `from foundry_sdk.v2.admin.models import PreregisterGroupRequest` |
Expand Down Expand Up @@ -3198,6 +3200,7 @@ Namespace | Name | Import |
**Admin** | ListHostsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListHostsPermissionDenied` |
**Admin** | ListMarkingMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingMembersPermissionDenied` |
**Admin** | ListMarkingRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListMarkingRoleAssignmentsPermissionDenied` |
**Admin** | ListOrganizationGuestMembersPermissionDenied | `from foundry_sdk.v2.admin.errors import ListOrganizationGuestMembersPermissionDenied` |
**Admin** | ListOrganizationRoleAssignmentsPermissionDenied | `from foundry_sdk.v2.admin.errors import ListOrganizationRoleAssignmentsPermissionDenied` |
**Admin** | MarkingCategoryNotFound | `from foundry_sdk.v2.admin.errors import MarkingCategoryNotFound` |
**Admin** | MarkingNameInCategoryAlreadyExists | `from foundry_sdk.v2.admin.errors import MarkingNameInCategoryAlreadyExists` |
Expand Down
2 changes: 1 addition & 1 deletion docs-snippets-npm/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"sls": {
"dependencies": {
"com.palantir.foundry.api:api-gateway": {
"minVersion": "1.1497.0",
"minVersion": "1.1499.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
5 changes: 5 additions & 0 deletions docs-snippets-npm/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -448,6 +448,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets<typeof PLATFORM_API_DOCS_SPEC
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OrganizationRid\norganization_rid = None\n# OrganizationName\nname = \"Example Organization\"\n# Optional[str]\ndescription = None\n# Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization.\nhost = \"example.palantirfoundry.com\"\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.admin.Organization.replace(\n organization_rid, name=name, description=description, host=host, preview=preview\n )\n print(\"The replace response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling Organization.replace: %s\\n\" % e)"
}
],
"v2.listOrganizationGuestMembers": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OrganizationRid\norganization_rid = None\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.admin.Organization.OrganizationGuestMember.list(\n organization_rid, preview=preview\n )\n print(\"The list response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OrganizationGuestMember.list: %s\\n\" % e)"
}
],
"v2.addOrganizationRoleAssignments": [
{
"template": "from foundry_sdk import FoundryClient\nimport foundry_sdk\nfrom pprint import pprint\n\nclient = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname=\"example.palantirfoundry.com\")\n\n# OrganizationRid\norganization_rid = None\n# List[RoleAssignmentUpdate]\nrole_assignments = [\n {\n \"roleId\": \"8bf49052-dc37-4528-8bf0-b551cfb71268\",\n \"principalId\": \"f05f8da4-b84c-4fca-9c77-8af0b13d11de\",\n }\n]\n# Optional[PreviewMode] | Enables the use of preview functionality.\npreview = None\n\n\ntry:\n api_response = client.admin.Organization.OrganizationRoleAssignment.add(\n organization_rid, role_assignments=role_assignments, preview=preview\n )\n print(\"The add response:\\n\")\n pprint(api_response)\nexcept foundry_sdk.PalantirRPCException as e:\n print(\"HTTP error when calling OrganizationRoleAssignment.add: %s\\n\" % e)"
Expand Down
59 changes: 59 additions & 0 deletions docs/v2/Admin/OrganizationGuestMember.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# OrganizationGuestMember

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**list**](#list) | **GET** /v2/admin/organizations/{organizationRid}/guestMembers | Private Beta |

# **list**
Lists all guest members of an Organization.


### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListOrganizationGuestMembersResponse**

### Example

```python
from foundry_sdk import FoundryClient
import foundry_sdk
from pprint import pprint

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

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


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

```



### Authorization

See [README](../../../README.md#authorization)

### HTTP response details
| Status Code | Type | Description | Content Type |
|-------------|-------------|-------------|------------------|
**200** | ListOrganizationGuestMembersResponse | | 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)

3 changes: 2 additions & 1 deletion docs/v2/Admin/User.md
Original file line number Diff line number Diff line change
Expand Up @@ -407,7 +407,8 @@ See [README](../../../README.md#authorization)
[[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)

# **search**
Perform a case-insensitive prefix search for users based on username, given name and family name.
Perform a case-insensitive prefix search for active users based on username, given name and family name.
Deleted users are not included in results. To list deleted users, use the `list` endpoint with `include=DELETED`.


### Parameters
Expand Down
12 changes: 12 additions & 0 deletions docs/v2/Admin/models/ListOrganizationGuestMembersResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# ListOrganizationGuestMembersResponse

ListOrganizationGuestMembersResponse

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**data** | List[OrganizationGuestMember] | 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 docs/v2/Admin/models/OrganizationGuestMember.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# OrganizationGuestMember

OrganizationGuestMember

## Properties
| Name | Type | Required | Description |
| ------------ | ------------- | ------------- | ------------- |
**principal_type** | PrincipalType | Yes | |
**principal_id** | PrincipalId | Yes | |


[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md)
2 changes: 1 addition & 1 deletion foundry_sdk/_version.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@
# using the autorelease bot
__version__ = "0.0.0"

__openapi_document_version__ = "1.1497.0"
__openapi_document_version__ = "1.1499.0"
16 changes: 16 additions & 0 deletions foundry_sdk/v2/admin/errors.py
Original file line number Diff line number Diff line change
Expand Up @@ -605,6 +605,21 @@ class ListMarkingRoleAssignmentsPermissionDenied(errors.PermissionDeniedError):
error_instance_id: str


class ListOrganizationGuestMembersPermissionDeniedParameters(typing_extensions.TypedDict):
"""The provided token does not have permission to list guest members for this organization."""

__pydantic_config__ = {"extra": "allow"} # type: ignore

organizationRid: core_models.OrganizationRid


@dataclass
class ListOrganizationGuestMembersPermissionDenied(errors.PermissionDeniedError):
name: typing.Literal["ListOrganizationGuestMembersPermissionDenied"]
parameters: ListOrganizationGuestMembersPermissionDeniedParameters
error_instance_id: str


class ListOrganizationRoleAssignmentsPermissionDeniedParameters(typing_extensions.TypedDict):
"""The provided token does not have permission to list assigned roles for this organization."""

Expand Down Expand Up @@ -1124,6 +1139,7 @@ class UserProviderInfoNotFound(errors.NotFoundError):
"ListHostsPermissionDenied",
"ListMarkingMembersPermissionDenied",
"ListMarkingRoleAssignmentsPermissionDenied",
"ListOrganizationGuestMembersPermissionDenied",
"ListOrganizationRoleAssignmentsPermissionDenied",
"MarkingCategoryNotFound",
"MarkingNameInCategoryAlreadyExists",
Expand Down
16 changes: 16 additions & 0 deletions foundry_sdk/v2/admin/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,13 @@ class ListMarkingsResponse(core.ModelBase):
next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required]


class ListOrganizationGuestMembersResponse(core.ModelBase):
"""ListOrganizationGuestMembersResponse"""

data: typing.List[OrganizationGuestMember]
next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required]


class ListOrganizationRoleAssignmentsResponse(core.ModelBase):
"""ListOrganizationRoleAssignmentsResponse"""

Expand Down Expand Up @@ -577,6 +584,13 @@ class Organization(core.ModelBase):
"""


class OrganizationGuestMember(core.ModelBase):
"""OrganizationGuestMember"""

principal_type: core_models.PrincipalType = pydantic.Field(alias=str("principalType")) # type: ignore[literal-required]
principal_id: core_models.PrincipalId = pydantic.Field(alias=str("principalId")) # type: ignore[literal-required]


OrganizationName = str
"""OrganizationName"""

Expand Down Expand Up @@ -897,6 +911,7 @@ class UserSearchFilter(core.ModelBase):
"ListMarkingMembersResponse",
"ListMarkingRoleAssignmentsResponse",
"ListMarkingsResponse",
"ListOrganizationGuestMembersResponse",
"ListOrganizationRoleAssignmentsResponse",
"ListUsersResponse",
"Marking",
Expand All @@ -917,6 +932,7 @@ class UserSearchFilter(core.ModelBase):
"MarkingType",
"OidcAuthenticationProtocol",
"Organization",
"OrganizationGuestMember",
"OrganizationName",
"OrganizationRoleAssignment",
"PreregisterGroupRequest",
Expand Down
24 changes: 24 additions & 0 deletions foundry_sdk/v2/admin/organization.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,18 @@ def OrganizationRoleAssignment(self):
config=self._config,
)

@cached_property
def OrganizationGuestMember(self):
from foundry_sdk.v2.admin.organization_guest_member import (
OrganizationGuestMemberClient,
) # NOQA

return OrganizationGuestMemberClient(
auth=self._auth,
hostname=self._hostname,
config=self._config,
)

@core.maybe_ignore_preview
@pydantic.validate_call
@errors.handle_unexpected
Expand Down Expand Up @@ -369,6 +381,18 @@ def OrganizationRoleAssignment(self):
config=self._config,
)

@cached_property
def OrganizationGuestMember(self):
from foundry_sdk.v2.admin.organization_guest_member import (
AsyncOrganizationGuestMemberClient,
) # NOQA

return AsyncOrganizationGuestMemberClient(
auth=self._auth,
hostname=self._hostname,
config=self._config,
)

@core.maybe_ignore_preview
@pydantic.validate_call
@errors.handle_unexpected
Expand Down
Loading