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
39 changes: 39 additions & 0 deletions README.md

Large diffs are not rendered by default.

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.1510.0",
"maxVersion": "1.x.x",
"optional": false
}
Expand Down
52 changes: 36 additions & 16 deletions docs-snippets-npm/src/index.ts

Large diffs are not rendered by default.

12 changes: 1 addition & 11 deletions docs/v2/Admin/AuthenticationProvider.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,17 +223,7 @@ organization = "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
# UserUsername | The new user's username. This must match one of the provider's supported username patterns.
username = "jsmith"
# Optional[Dict[AttributeName, AttributeValues]]
attributes = {
"multipass:givenName": ["John"],
"multipass:familyName": ["Smith"],
"multipass:email:primary": ["jsmith@example.com"],
"multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"],
"multipass:organization-rid": [
"ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"
],
"department": ["Finance"],
"jobTitle": ["Accountant"],
}
attributes = {"department": ["Finance"], "jobTitle": ["Accountant"]}
# Optional[str]
email = "jsmith@example.com"
# Optional[str]
Expand Down
61 changes: 61 additions & 0 deletions docs/v2/Admin/CbacBanner.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
# CbacBanner

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/admin/cbacBanner | Public Beta |

# **get**
Returns a classification banner string and colors for the given set of marking IDs.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**display_type** | Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING. | [optional] |
**marking_ids** | Optional[List[MarkingId]] | The marking IDs for which to generate a banner. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**CbacBanner**

### Example

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

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

# Optional[ClassificationBannerDisplayType] | The display type of the banner. Defaults to PORTION_MARKING.
display_type = None
# Optional[List[MarkingId]] | The marking IDs for which to generate a banner.
marking_ids = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


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

```



### Authorization

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

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

58 changes: 58 additions & 0 deletions docs/v2/Admin/CbacMarkingRestrictions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# CbacMarkingRestrictions

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/admin/cbacMarkingRestrictions | Public Beta |

# **get**
Returns disallowed, implied, and required markings for the given set of marking IDs.

### Parameters

Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**marking_ids** | Optional[List[MarkingId]] | The marking IDs for which to get restrictions. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**CbacMarkingRestrictions**

### Example

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

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

# Optional[List[MarkingId]] | The marking IDs for which to get restrictions.
marking_ids = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


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

```



### Authorization

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

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

4 changes: 2 additions & 2 deletions docs/v2/Admin/Enrollment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Private Beta |
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Private Beta |
[**get**](#get) | **GET** /v2/admin/enrollments/{enrollmentRid} | Public Beta |
[**get_current**](#get_current) | **GET** /v2/admin/enrollments/getCurrent | Public Beta |

# **get**
Get the Enrollment with the specified rid.
Expand Down
6 changes: 3 additions & 3 deletions docs/v2/Admin/EnrollmentRoleAssignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Private Beta |
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Private Beta |
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Private Beta |
[**add**](#add) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/add | Public Beta |
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/roleAssignments | Public Beta |
[**remove**](#remove) | **POST** /v2/admin/enrollments/{enrollmentRid}/roleAssignments/remove | Public Beta |

# **add**
Assign roles to principals for the given Enrollment. At most 100 role assignments can be added in a single request.
Expand Down
16 changes: 4 additions & 12 deletions docs/v2/Admin/GroupProviderInfo.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Public Beta |
[**get**](#get) | **GET** /v2/admin/groups/{groupId}/providerInfo | Stable |
[**replace**](#replace) | **PUT** /v2/admin/groups/{groupId}/providerInfo | Stable |

# **get**
Get the GroupProviderInfo.
Expand All @@ -13,7 +13,6 @@ Get the GroupProviderInfo.
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**group_id** | GroupId | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**GroupProviderInfo**
Expand All @@ -29,12 +28,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa

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


try:
api_response = client.admin.Group.ProviderInfo.get(group_id, preview=preview)
api_response = client.admin.Group.ProviderInfo.get(group_id)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand Down Expand Up @@ -64,7 +61,6 @@ Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**group_id** | GroupId | | |
**provider_id** | ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm. | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**GroupProviderInfo**
Expand All @@ -82,14 +78,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
group_id = None
# ProviderId | The ID of the Group in the external authentication provider. This value is determined by the authentication provider. At most one Group can have a given provider ID in a given Realm.
provider_id = "2838c8f3-d76a-4e99-acf1-1dee537e4c48"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Group.ProviderInfo.replace(
group_id, provider_id=provider_id, preview=preview
)
api_response = client.admin.Group.ProviderInfo.replace(group_id, provider_id=provider_id)
print("The replace response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand Down
2 changes: 1 addition & 1 deletion docs/v2/Admin/Host.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Private Beta |
[**list**](#list) | **GET** /v2/admin/enrollments/{enrollmentRid}/hosts | Public Beta |

# **list**
Lists all Hosts.
Expand Down
19 changes: 7 additions & 12 deletions docs/v2/Admin/MarkingCategory.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/admin/markingCategories | Private Beta |
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Public Beta |
[**list**](#list) | **GET** /v2/admin/markingCategories | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | Private Beta |
[**create**](#create) | **POST** /v2/admin/markingCategories | Public Beta |
[**get**](#get) | **GET** /v2/admin/markingCategories/{markingCategoryId} | Stable |
[**list**](#list) | **GET** /v2/admin/markingCategories | Stable |
[**replace**](#replace) | **PUT** /v2/admin/markingCategories/{markingCategoryId} | Public Beta |

# **create**
Creates a new MarkingCategory.
Expand Down Expand Up @@ -37,6 +37,7 @@ description = "Markings related to data about our customers"
initial_permissions = {
"organizationRids": ["ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa"],
"roles": [{"role": "ADMINISTER", "principalId": "f05f8da4-b84c-4fca-9c77-8af0b13d11de"}],
"isPublic": False,
}
# MarkingCategoryName
name = "Customer Data"
Expand Down Expand Up @@ -76,7 +77,6 @@ Get the MarkingCategory with the specified id.
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**marking_category_id** | MarkingCategoryId | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**MarkingCategory**
Expand All @@ -92,12 +92,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa

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


try:
api_response = client.admin.MarkingCategory.get(marking_category_id, preview=preview)
api_response = client.admin.MarkingCategory.get(marking_category_id)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand Down Expand Up @@ -127,7 +125,6 @@ Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**page_size** | Optional[PageSize] | The page size to use for the endpoint. | [optional] |
**page_token** | Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListMarkingCategoriesResponse**
Expand All @@ -145,13 +142,11 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa
page_size = None
# Optional[PageToken] | The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the `nextPageToken` field of the previous response and use it to populate the `pageToken` field of the next request.
page_token = None
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
for marking_category in client.admin.MarkingCategory.list(
page_size=page_size, page_token=page_token, preview=preview
page_size=page_size, page_token=page_token
):
pprint(marking_category)
except foundry_sdk.PalantirRPCException as e:
Expand Down
23 changes: 7 additions & 16 deletions docs/v2/Admin/Organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

Method | HTTP request | Release Stage |
------------- | ------------- | ----- |
[**create**](#create) | **POST** /v2/admin/organizations | Private Beta |
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Public Beta |
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Public Beta |
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Public Beta |
[**create**](#create) | **POST** /v2/admin/organizations | Public Beta |
[**get**](#get) | **GET** /v2/admin/organizations/{organizationRid} | Stable |
[**list_available_roles**](#list_available_roles) | **GET** /v2/admin/organizations/{organizationRid}/listAvailableRoles | Stable |
[**replace**](#replace) | **PUT** /v2/admin/organizations/{organizationRid} | Stable |

# **create**
Creates a new Organization.
Expand Down Expand Up @@ -84,7 +84,6 @@ Get the Organization with the specified rid.
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**Organization**
Expand All @@ -100,12 +99,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa

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


try:
api_response = client.admin.Organization.get(organization_rid, preview=preview)
api_response = client.admin.Organization.get(organization_rid)
print("The get response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand Down Expand Up @@ -135,7 +132,6 @@ List all roles that can be assigned to a principal for the given Organization.
Name | Type | Description | Notes |
------------- | ------------- | ------------- | ------------- |
**organization_rid** | OrganizationRid | | |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**ListAvailableOrganizationRolesResponse**
Expand All @@ -151,12 +147,10 @@ client = FoundryClient(auth=foundry_sdk.UserTokenAuth(...), hostname="example.pa

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


try:
api_response = client.admin.Organization.list_available_roles(organization_rid, preview=preview)
api_response = client.admin.Organization.list_available_roles(organization_rid)
print("The list_available_roles response:\n")
pprint(api_response)
except foundry_sdk.PalantirRPCException as e:
Expand Down Expand Up @@ -188,7 +182,6 @@ Name | Type | Description | Notes |
**name** | OrganizationName | | |
**description** | Optional[str] | | [optional] |
**host** | Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization. | [optional] |
**preview** | Optional[PreviewMode] | Enables the use of preview functionality. | [optional] |

### Return type
**Organization**
Expand All @@ -210,13 +203,11 @@ name = "Example Organization"
description = None
# Optional[HostName] | The primary host name of the Organization. This should be used when constructing URLs for users of this Organization.
host = "example.palantirfoundry.com"
# Optional[PreviewMode] | Enables the use of preview functionality.
preview = None


try:
api_response = client.admin.Organization.replace(
organization_rid, name=name, description=description, host=host, preview=preview
organization_rid, name=name, description=description, host=host
)
print("The replace response:\n")
pprint(api_response)
Expand Down
Loading