TenantContextAPI

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

Method	HTTP request	Description
get-tenant-context-v1	Get /tenant-context/v1	Retrieve tenant context
patch-tenant-context-v1	Patch /tenant-context/v1	Update tenant context

get-tenant-context-v1

Retrieve tenant context Returns all key-value pairs representing the current state of the tenant's context. Each tenant is limited to a maximum of 100 key-value pairs.

API Spec

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiGetTenantContextV1Request struct via the builder pattern

Return type

[]GetTenantContextV1200ResponseInner

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  
    
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/tenant_context"
)

func main() {

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.TenantContextAPI.GetTenantContextV1(context.Background()).Execute()
	  //resp, r, err := apiClient.TenantContextAPI.GetTenantContextV1(context.Background()).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.GetTenantContextV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetTenantContextV1`: []GetTenantContextV1200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `TenantContextAPI.GetTenantContextV1`: %v\n", resp)
}

[Back to top]

patch-tenant-context-v1

Update tenant context Allows the user to make incremental updates to tenant context records using JSON Patch 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

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiPatchTenantContextV1Request struct via the builder pattern

Name	Type	Description	Notes
jsonpatchoperation	Jsonpatchoperation

Return type

(empty response body)

HTTP request headers

• Content-Type: application/json-patch+json
• Accept: application/json

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v1 "github.com/sailpoint-oss/golang-sdk/v3/tenant_context"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/tenant_context"
)

func main() {
    jsonpatchoperation := []byte(`[{"op":"add","path":"/Key/IAS","value":"Integrated Automation System"},{"op":"replace","path":"/Key/IAS","value":"International Accounting Standards"},{"op":"remove","path":"/Key/NDR"}]`) // Jsonpatchoperation | 

    var jsonpatchoperation v1.Jsonpatchoperation
    if err := json.Unmarshal(jsonpatchoperation, &jsonpatchoperation); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    r, err := apiClient.TenantContextAPI.PatchTenantContextV1(context.Background()).Jsonpatchoperation(jsonpatchoperation).Execute()
	  //r, err := apiClient.TenantContextAPI.PatchTenantContextV1(context.Background()).Jsonpatchoperation(jsonpatchoperation).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `TenantContextAPI.PatchTenantContextV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    
}

[Back to top]