mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-07 12:27:47 +00:00
Update to powershell SDK docs: 14063829196
This commit is contained in:
developer-relations-sp
@@ -0,0 +1,134 @@
|
||||
---
|
||||
id: v2024-tenant-context
|
||||
title: TenantContext
|
||||
pagination_label: TenantContext
|
||||
sidebar_label: TenantContext
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'TenantContext', 'V2024TenantContext']
|
||||
slug: /tools/sdk/powershell/v2024/methods/tenant-context
|
||||
tags: ['SDK', 'Software Development Kit', 'TenantContext', 'V2024TenantContext']
|
||||
---
|
||||
|
||||
# TenantContext
|
||||
The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant.
|
||||
Context key-value pairs will consist of common terms and acronyms used within your organization.
|
||||
|
||||
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**Get-V2024TenantContext**](#get-tenant-context) | **GET** `/tenant-context` | Retrieve tenant context
|
||||
[**Update-V2024TenantContext**](#patch-tenant-context) | **PATCH** `/tenant-context` | Update tenant context
|
||||
|
||||
|
||||
## get-tenant-context
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Returns a list of key-value pairs representing the current state of the tenant's context.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant-context)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**GetTenantContext200ResponseInner[]**](../models/get-tenant-context200-response-inner)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Successfully retrieved tenant context. | GetTenantContext200ResponseInner[]
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
|
||||
# Retrieve tenant context
|
||||
|
||||
try {
|
||||
Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Get-V2024TenantContext -XSailPointExperimental $XSailPointExperimental
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TenantContext"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-tenant-context
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Allows the user to make incremental updates to tenant context records using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
This endpoint is specifically designed to modify the `/Key/*` field, supporting operations such as `add`, `remove`, or `replace` to manage key-value pairs.
|
||||
|
||||
Note that each tenant is limited to a maximum of 100 key-value pairs.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-tenant-context)
|
||||
|
||||
### Parameters
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| XSailPointExperimental | **String** | True (default to "true") | Use this header to enable this experimental API.
|
||||
Body | JsonPatchOperation | [**JsonPatchOperation**](../models/json-patch-operation) | True |
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type
|
||||
------------- | ------------- | -------------
|
||||
200 | Tenant context updated successfully. |
|
||||
400 | Bad request due to invalid input parameters. | ErrorResponseDto
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
```powershell
|
||||
$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
|
||||
$JsonPatchOperation = @"{
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}"@
|
||||
|
||||
# Update tenant context
|
||||
|
||||
try {
|
||||
$Result = ConvertFrom-JsonToJsonPatchOperation -Json $JsonPatchOperation
|
||||
Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# Update-V2024TenantContext -XSailPointExperimental $XSailPointExperimental -JsonPatchOperation $Result
|
||||
} catch {
|
||||
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-V2024TenantContext"
|
||||
Write-Host $_.ErrorDetails
|
||||
}
|
||||
```
|
||||
[[Back to top]](#)
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-get-tenant-context200-response-inner
|
||||
title: GetTenantContext200ResponseInner
|
||||
pagination_label: GetTenantContext200ResponseInner
|
||||
sidebar_label: GetTenantContext200ResponseInner
|
||||
sidebar_class_name: powershellsdk
|
||||
keywords: ['powershell', 'PowerShell', 'sdk', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner']
|
||||
slug: /tools/sdk/powershell/v2024/models/get-tenant-context200-response-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'GetTenantContext200ResponseInner', 'V2024GetTenantContext200ResponseInner']
|
||||
---
|
||||
|
||||
|
||||
# GetTenantContext200ResponseInner
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**Key** | **String** | | [optional]
|
||||
**Value** | **String** | | [optional]
|
||||
|
||||
## Examples
|
||||
|
||||
- Prepare the resource
|
||||
```powershell
|
||||
$GetTenantContext200ResponseInner = Initialize-PSSailpoint.V2024GetTenantContext200ResponseInner -Key null `
|
||||
-Value null
|
||||
```
|
||||
|
||||
- Convert the resource to JSON
|
||||
```powershell
|
||||
$GetTenantContext200ResponseInner | ConvertTo-JSON
|
||||
```
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
Reference in New Issue
Block a user