developer.sailpoint.com/docs/tools/sdk/go/Reference/Beta/Methods/IconsAPI.md

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

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
beta-icons	Icons	Icons	Icons	gosdk	go Golang sdk Icons BetaIcons	/tools/sdk/go/beta/methods/icons	SDK Software Development Kit Icons BetaIcons

\IconsAPI

Use this API to implement functionality related to object icons (application icons for example). With this functionality in place, administrators can set or remove an icon for specific object type for use throughout Identity Security Cloud.

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

Method	HTTP request	Description
delete-icon	Delete /icons/{objectType}/{objectId}	Delete an icon
set-icon	Put /icons/{objectType}/{objectId}	Update an icon

delete-icon

Delete an icon This API endpoint delete an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
objectType	string	Object type
objectId	string	Object id.

Other Parameters

Other parameters are passed through a pointer to a apiDeleteIconRequest 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"
	openapiclient "github.com/sailpoint-oss/golang-sdk/v2"
)

func main() {
    objectType := application # string | Object type # string | Object type
    objectId := a291e870-48c3-4953-b656-fb5ce2a93169 # string | Object id. # string | Object id.

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

[Back to top]

set-icon

Update an icon This API endpoint updates an icon by object type and object id. A token with ORG_ADMIN authority is required to call this API.

API Spec

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
objectType	string	Object type
objectId	string	Object id.

Other Parameters

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

Name	Type	Description	Notes

image | *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] |

Return type

SetIcon200Response

HTTP request headers

• Content-Type: multipart/form-data
• Accept: application/json

Example

package main

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

func main() {
    objectType := application # string | Object type # string | Object type
    objectId := a291e870-48c3-4953-b656-fb5ce2a93169 # string | Object id. # string | Object id.
    image := BINARY_DATA_HERE # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg'] # *os.File | file with icon. Allowed mime-types ['image/png', 'image/jpeg']

	configuration := NewDefaultConfiguration()
	apiClient := NewAPIClient(configuration)
	resp, r, err := apiClient.IconsAPI.SetIcon(context.Background(), objectType, objectId).Image(image).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IconsAPI.SetIcon``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `SetIcon`: SetIcon200Response
	fmt.Fprintf(os.Stdout, "Response from `IconsAPI.SetIcon`: %v\n", resp)
}

[Back to top]