LukeParke/developer.sailpoint.com

Fork 0

mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00

Files

developer-relations-sp fd7deb00fd Update Go SDK docs: 15116527960

2025-05-19 15:06:17 +00:00

15 KiB

Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

title

pagination_label

sidebar_label

sidebar_class_name

keywords

slug

ConnectorCustomizersAPI

Saas Connectivity Customizers are cloud-based connector customizers. The customizers allow you to customize the out of the box connectors in a similar way to how you can use rules to customize VA (virtual appliance) based connectors.

Use these APIs to implement connector customizers functionality.

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

Method	HTTP request	Description
create-connector-customizer	Post `/connector-customizers`	Create connector customizer
create-connector-customizer-version	Post `/connector-customizers/{id}/versions`	Creates a connector customizer version
delete-connector-customizer	Delete `/connector-customizers/{id}`	Delete connector customizer
get-connector-customizer	Get `/connector-customizers/{id}`	Get connector customizer
list-connector-customizers	Get `/connector-customizers`	List all connector customizers
put-connector-customizer	Put `/connector-customizers/{id}`	Update connector customizer

create-connector-customizer

Create connector customizer Create a connector customizer.

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
connectorCustomizerCreateRequest	ConnectorCustomizerCreateRequest	Connector customizer to create.

Return type

ConnectorCustomizerCreateResponse

HTTP request headers

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

Example

package main

import (
	"context"
	"fmt"
	"os"
  "encoding/json"
    v2024 "github.com/sailpoint-oss/golang-sdk/v2/api_v2024"
	sailpoint "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    connectorcustomizercreaterequest := []byte(`{
          "name" : "My Custom Connector"
        }`) // ConnectorCustomizerCreateRequest | Connector customizer to create.

    var connectorCustomizerCreateRequest v2024.ConnectorCustomizerCreateRequest
    if err := json.Unmarshal(connectorcustomizercreaterequest, &connectorCustomizerCreateRequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

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

[Back to top]

create-connector-customizer-version

Creates a connector customizer version Creates a new version for the customizer.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	The id of the connector customizer.

Other Parameters

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

Name	Type	Description	Notes

Return type

ConnectorCustomizerVersionCreateResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

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

func main() {
    id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | The id of the connector customizer. # string | The id of the connector customizer.

    

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

[Back to top]

delete-connector-customizer

Delete connector customizer Delete the connector customizer for the given ID.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector customizer to delete.

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

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

func main() {
    id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to delete. # string | ID of the connector customizer to delete.

    

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

[Back to top]

get-connector-customizer

Get connector customizer Gets connector customizer by ID.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector customizer to get.

Other Parameters

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

Name	Type	Description	Notes

Return type

ConnectorCustomizersResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

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

func main() {
    id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to get. # string | ID of the connector customizer to get.

    

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

[Back to top]

list-connector-customizers

List all connector customizers List all connector customizers.

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
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]

Return type

[]ConnectorCustomizersResponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

package main

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

func main() {
    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)

    

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

[Back to top]

put-connector-customizer

Update connector customizer Update an existing connector customizer with the one provided in the request body. These fields are immutable: id, name, type.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
id	string	ID of the connector customizer to update.

Other Parameters

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

Name	Type	Description	Notes

connectorCustomizerUpdateRequest | ConnectorCustomizerUpdateRequest | Connector rule with updated data. |

Return type

ConnectorCustomizerUpdateResponse

HTTP request headers

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

Example

package main

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

func main() {
    id := `b07dc46a-1498-4de8-bfbb-259a68e70c8a` // string | ID of the connector customizer to update. # string | ID of the connector customizer to update.
    connectorcustomizerupdaterequest := []byte(`{
          "name" : "My Custom Connector"
        }`) // ConnectorCustomizerUpdateRequest | Connector rule with updated data. (optional)

    

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

[Back to top]

15 KiB Raw Blame History

ConnectorCustomizersAPI

create-connector-customizer

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

create-connector-customizer-version

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

delete-connector-customizer

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-connector-customizer

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

list-connector-customizers

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

put-connector-customizer

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

15 KiB

Raw Blame History