Skip to main content

OrgConfigAPI

Use this API to implement organization configuration functionality. Administrators can use this functionality to manage organization settings, such as time zones.

All URIs are relative to https://sailpoint.api.identitynow.com

MethodHTTP requestDescription
get-org-config-v1Get /org-config/v1Get org config settings
get-valid-time-zones-v1Get /org-config/v1/valid-time-zonesGet valid time zones
patch-org-config-v1Patch /org-config/v1Patch org config

get-org-config-v1​

Get org config settings Get the current organization's configuration settings, only external accessible properties.

API Spec

Path Parameters​

This endpoint does not need any parameter.

Other Parameters​

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

Return type​

Orgconfig

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/org_config"
)

func main() {

    

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

[Back to top]

get-valid-time-zones-v1​

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.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
  configuration.Experimental = true

Get valid time zones List the valid time zones that can be set in organization configurations.

API Spec

Path Parameters​

Other Parameters​

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

NameTypeDescriptionNotes
xSailPointExperimentalstringUse this header to enable this experimental API.[default to "true"]
limitint32Note that for this API the maximum value for limit is 50. See V3 API Standard Collection Parameters for more information.[default to 50]
offsetint32Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.[default to 0]
countboolIf true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.[default to false]

Return type​

[]string

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/org_config"
)

func main() {
    xSailPointExperimental := `true` // string | Use this header to enable this experimental API. (default to "true") # string | Use this header to enable this experimental API. (default to "true")
    limit := 50 // int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int32 | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
    offset := 0 // int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count := true // bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to false)

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.OrgConfigAPI.GetValidTimeZonesV1(context.Background()).XSailPointExperimental(xSailPointExperimental).Execute()
	  //resp, r, err := apiClient.OrgConfigAPI.GetValidTimeZonesV1(context.Background()).XSailPointExperimental(xSailPointExperimental).Limit(limit).Offset(offset).Count(count).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `OrgConfigAPI.GetValidTimeZonesV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetValidTimeZonesV1`: []string
    fmt.Fprintf(os.Stdout, "Response from `OrgConfigAPI.GetValidTimeZonesV1`: %v\n", resp)
}

[Back to top]

patch-org-config-v1​

Patch org config Patch the current organization's configuration, using http://jsonpatch.com/ syntax. This is commonly used to changing an organization's time zone.

API Spec

Path Parameters​

Other Parameters​

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

NameTypeDescriptionNotes
jsonpatchoperation[]JsonpatchoperationA list of schema attribute update operations according to the JSON Patch standard.

Return type​

Orgconfig

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/org_config"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v3/org_config"
)

func main() {
    jsonpatchoperation := []byte(`[{"op":"replace","path":"/timeZone","value":"America/Toronto"}]`) // []Jsonpatchoperation | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.

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

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

[Back to top]