LaunchersAPI

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

Method	HTTP request	Description
create-launcher-v1	Post `/launchers/v1`	Create launcher
delete-launcher-v1	Delete `/launchers/v1/{launcherID}`	Delete launcher
get-launcher-v1	Get `/launchers/v1/{launcherID}`	Get launcher by id
get-launchers-v1	Get `/launchers/v1`	List all launchers for tenant
put-launcher-v1	Put `/launchers/v1/{launcherID}`	Replace launcher
start-launcher-v1	Post `/launchers/v1/{launcherID}/launch`	Launch a launcher

create-launcher-v1

Create launcher Create a Launcher with given information

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
launcherrequest	Launcherrequest	Payload to create a Launcher

Return type

Launcher

HTTP request headers

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

Example

package main

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

func main() {
    launcherrequestJson := []byte(``) // Launcherrequest | Payload to create a Launcher

    var launcherrequest launchers.Launcherrequest
    if err := json.Unmarshal(launcherrequestJson, &launcherrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

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

[Back to top]

delete-launcher-v1

Delete launcher Delete the given Launcher ID

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
launcherID	string	ID of the Launcher to be deleted

Other Parameters

Other parameters are passed through a pointer to a apiDeleteLauncherV1Request 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/v3"
)

func main() {
    launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be deleted # string | ID of the Launcher to be deleted

    

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

[Back to top]

get-launcher-v1

Get launcher by id Get details for the given Launcher ID

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
launcherID	string	ID of the Launcher to be retrieved

Other Parameters

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

Name	Type	Description	Notes

Return type

Launcher

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

func main() {
    launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be retrieved # string | ID of the Launcher to be retrieved

    

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

[Back to top]

get-launchers-v1

List all launchers for tenant Return a list of Launchers for the authenticated tenant

API Spec

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
filters	string	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: description: sw disabled: eq name: sw
next	string	Pagination marker
limit	int32	Number of Launchers to return	[default to 10]

Return type

GetLaunchersV1200Response

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

func main() {
    filters := `disabled eq "true"` // 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:  **description**: *sw*  **disabled**: *eq*  **name**: *sw* (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:  **description**: *sw*  **disabled**: *eq*  **name**: *sw* (optional)
    next := `eyJuZXh0IjoxMjN9Cg==` // string | Pagination marker (optional) # string | Pagination marker (optional)
    limit := 42 // int32 | Number of Launchers to return (optional) (default to 10) # int32 | Number of Launchers to return (optional) (default to 10)

    

    configuration := sailpoint.NewDefaultConfiguration()
    apiClient := sailpoint.NewAPIClient(configuration)
    resp, r, err := apiClient.LaunchersAPI.GetLaunchersV1(context.Background()).Execute()
	  //resp, r, err := apiClient.LaunchersAPI.GetLaunchersV1(context.Background()).Filters(filters).Next(next).Limit(limit).Execute()
    if err != nil {
	    fmt.Fprintf(os.Stderr, "Error when calling `LaunchersAPI.GetLaunchersV1``: %v\n", err)
	    fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetLaunchersV1`: GetLaunchersV1200Response
    fmt.Fprintf(os.Stdout, "Response from `LaunchersAPI.GetLaunchersV1`: %v\n", resp)
}

[Back to top]

put-launcher-v1

Replace launcher Replace the given Launcher ID with given payload

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
launcherID	string	ID of the Launcher to be replaced

Other Parameters

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

Name	Type	Description	Notes

launcherrequest | Launcherrequest | Payload to replace Launcher |

Return type

Launcher

HTTP request headers

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

Example

package main

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

func main() {
    launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be replaced # string | ID of the Launcher to be replaced
    launcherrequestJson := []byte(``) // Launcherrequest | Payload to replace Launcher

    var launcherrequest launchers.Launcherrequest
    if err := json.Unmarshal(launcherrequestJson, &launcherrequest); err != nil {
      fmt.Println("Error:", err)
      return
    }
    

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

[Back to top]

start-launcher-v1

Launch a launcher Launch the given Launcher ID

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
launcherID	string	ID of the Launcher to be launched

Other Parameters

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

Name	Type	Description	Notes

Return type

StartLauncherV1200Response

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

func main() {
    launcherID := `e3012408-8b61-4564-ad41-c5ec131c325b` // string | ID of the Launcher to be launched # string | ID of the Launcher to be launched

    

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

[Back to top]

create-launcher-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

delete-launcher-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

get-launcher-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

get-launchers-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

put-launcher-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

start-launcher-v1​

Path Parameters​

Other Parameters​

Return type​

HTTP request headers​

Example​

create-launcher-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

delete-launcher-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-launcher-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

get-launchers-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

put-launcher-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example

start-launcher-v1

Path Parameters

Other Parameters

Return type

HTTP request headers

Example