IAICommonAccessAPI

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

Method	HTTP request	Description
create-common-access-v1	Post `/common-access/v1`	Create common access items
get-common-access-v1	Get `/common-access/v1`	Get a paginated list of common access
update-common-access-status-in-bulk-v1	Post `/common-access/v1/update-status`	Bulk update common access status

create-common-access-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

Create common access items This API is used to add roles/access profiles to the list of common access for a customer. Requires authorization scope of iai:access-modeling:create

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[default to "true"]
commonaccessitemrequest	Commonaccessitemrequest

Return type

Commonaccessitemresponse

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

package main

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

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")
    commonaccessitemrequest := []byte(``) // Commonaccessitemrequest | 

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

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

[Back to top]

get-common-access-v1

experimental

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 a paginated list of common access This endpoint returns the current common access for a customer. The returned items can be filtered and sorted. Requires authorization scope of iai:access-modeling:read

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[default to "true"]
offset	int32	Offset 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]
limit	int32	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[default to 250]
count	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 for more information.	[default to false]
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: status: eq, sw reviewedByUser eq access.id: eq, sw access.type: eq access.name: sw, eq access.description: sw, eq
sorters	string	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: access.name, status By default the common access items are sorted by name, ascending.

Return type

[]Commonaccessresponse

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

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")
    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)
    limit := 250 // int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    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)
    filters := `access.type eq "ROLE"` // string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **status**: *eq, sw*  **reviewedByUser** *eq*  **access.id**: *eq, sw*  **access.type**: *eq*  **access.name**: *sw, eq*  **access.description**: *sw, eq* (optional) # string | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **status**: *eq, sw*  **reviewedByUser** *eq*  **access.id**: *eq, sw*  **access.type**: *eq*  **access.name**: *sw, eq*  **access.description**: *sw, eq* (optional)
    sorters := `access.name` // string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **access.name, status**  By default the common access items are sorted by name, ascending. (optional) # string | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **access.name, status**  By default the common access items are sorted by name, ascending. (optional)

    

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

[Back to top]

update-common-access-status-in-bulk-v1

experimental

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

Bulk update common access status This submits an update request to the common access application. At this time there are no parameters. Requires authorization scope of iai:access-modeling:update

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
xSailPointExperimental	string	Use this header to enable this experimental API.	[default to "true"]
commonaccessidstatus	[]Commonaccessidstatus	Confirm or deny in bulk the common access ids that are (or aren't) common access

Return type

map[string]interface

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

package main

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

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")
    commonaccessidstatus := []byte(``) // []Commonaccessidstatus | Confirm or deny in bulk the common access ids that are (or aren't) common access

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

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.IAICommonAccessAPI.UpdateCommonAccessStatusInBulkV1(context.Background()).XSailPointExperimental(xSailPointExperimental).Commonaccessidstatus(commonaccessidstatus).Execute()
	  //resp, r, err := apiClient.IAICommonAccessAPI.UpdateCommonAccessStatusInBulkV1(context.Background()).XSailPointExperimental(xSailPointExperimental).Commonaccessidstatus(commonaccessidstatus).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `IAICommonAccessAPI.UpdateCommonAccessStatusInBulkV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateCommonAccessStatusInBulkV1`: map[string]interface{}
    fmt.Fprintf(os.Stdout, "Response from `IAICommonAccessAPI.UpdateCommonAccessStatusInBulkV1`: %v\n", resp)
}

[Back to top]

create-common-access-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

get-common-access-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

update-common-access-status-in-bulk-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

create-common-access-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-common-access-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

update-common-access-status-in-bulk-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example