All URIs are relative to https://sailpoint.api.identitynow.com/beta
Method | HTTP request | Description |
---|---|---|
CreateServiceDeskIntegration | Post /service-desk-integrations | Create new Service Desk integration |
DeleteServiceDeskIntegration | Delete /service-desk-integrations/{id} | Delete a Service Desk integration |
GetServiceDeskIntegration | Get /service-desk-integrations/{id} | Get a Service Desk integration |
GetServiceDeskIntegrationList | Get /service-desk-integrations | List existing Service Desk Integrations |
GetServiceDeskIntegrationTemplate | Get /service-desk-integrations/templates/{scriptName} | Service Desk integration template by scriptName. |
GetServiceDeskIntegrationTypes | Get /service-desk-integrations/types | Service Desk Integration Types List. |
GetStatusCheckDetails | Get /service-desk-integrations/status-check-configuration | Get the time check configuration |
PatchServiceDeskIntegration | Patch /service-desk-integrations/{id} | Service Desk Integration Update PATCH |
PutServiceDeskIntegration | Put /service-desk-integrations/{id} | Update a Service Desk integration |
UpdateStatusCheckDetails | Put /service-desk-integrations/status-check-configuration | Update the time check configuration |
ServiceDeskIntegrationDto CreateServiceDeskIntegration(ctx).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()
Create new Service Desk integration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
serviceDeskIntegrationDto := *openapiclient.NewServiceDeskIntegrationDto("aName", "A very nice Service Desk integration", "ServiceNowSDIM", map[string]interface{}{"key": interface{}(123)}) // ServiceDeskIntegrationDto | The specifics of a new integration to create
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.CreateServiceDeskIntegration(context.Background()).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.CreateServiceDeskIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `CreateServiceDeskIntegration`: ServiceDeskIntegrationDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.CreateServiceDeskIntegration`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiCreateServiceDeskIntegrationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
serviceDeskIntegrationDto | ServiceDeskIntegrationDto | The specifics of a new integration to create |
UserContextAuth, UserContextAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeleteServiceDeskIntegration(ctx, id).Execute()
Delete a Service Desk integration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "anId" // string | ID of Service Desk integration to delete
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.DeleteServiceDeskIntegration(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.DeleteServiceDeskIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of Service Desk integration to delete |
Other parameters are passed through a pointer to a apiDeleteServiceDeskIntegrationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
(empty response body)
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ServiceDeskIntegrationDto GetServiceDeskIntegration(ctx, id).Execute()
Get a Service Desk integration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "anId" // string | ID of the Service Desk integration to get
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.GetServiceDeskIntegration(context.Background(), id).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.GetServiceDeskIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetServiceDeskIntegration`: ServiceDeskIntegrationDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.GetServiceDeskIntegration`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of the Service Desk integration to get |
Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]ServiceDeskIntegrationDto GetServiceDeskIntegrationList(ctx).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute()
List existing Service Desk Integrations
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
offset := int32(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 := int32(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)
sorters := "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: **name** (optional)
filters := "id eq 2c91808b6ef1d43e016efba0ce470904" // 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: **id**: *eq, in* **name**: *eq* **type**: *eq, in* **cluster**: *eq, in* (optional)
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)
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.GetServiceDeskIntegrationList(context.Background()).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.GetServiceDeskIntegrationList``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetServiceDeskIntegrationList`: []ServiceDeskIntegrationDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.GetServiceDeskIntegrationList`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationListRequest 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] |
sorters | string | Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name | |
filters | string | Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: id: eq, in name: eq type: eq, in cluster: eq, in | |
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] |
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ServiceDeskIntegrationTemplateDto GetServiceDeskIntegrationTemplate(ctx, scriptName).Execute()
Service Desk integration template by scriptName.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
scriptName := "aScriptName" // string | The scriptName value of the Service Desk integration template to get
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.GetServiceDeskIntegrationTemplate(context.Background(), scriptName).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.GetServiceDeskIntegrationTemplate``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetServiceDeskIntegrationTemplate`: ServiceDeskIntegrationTemplateDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.GetServiceDeskIntegrationTemplate`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
scriptName | string | The scriptName value of the Service Desk integration template to get |
Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTemplateRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
ServiceDeskIntegrationTemplateDto
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
[]ServiceDeskIntegrationTemplateType GetServiceDeskIntegrationTypes(ctx).Execute()
Service Desk Integration Types List.
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.GetServiceDeskIntegrationTypes(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.GetServiceDeskIntegrationTypes``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetServiceDeskIntegrationTypes`: []ServiceDeskIntegrationTemplateType
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.GetServiceDeskIntegrationTypes`: %v\n", resp)
}
This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiGetServiceDeskIntegrationTypesRequest struct via the builder pattern
[]ServiceDeskIntegrationTemplateType
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueuedCheckConfigDetails GetStatusCheckDetails(ctx).Execute()
Get the time check configuration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.GetStatusCheckDetails(context.Background()).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.GetStatusCheckDetails``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `GetStatusCheckDetails`: QueuedCheckConfigDetails
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.GetStatusCheckDetails`: %v\n", resp)
}
This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiGetStatusCheckDetailsRequest struct via the builder pattern
UserContextAuth, UserContextAuth
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ServiceDeskIntegrationDto PatchServiceDeskIntegration(ctx, id).JsonPatch(jsonPatch).Execute()
Service Desk Integration Update PATCH
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "anId" // string | ID of the Service Desk integration to update
jsonPatch := *openapiclient.NewJsonPatch() // JsonPatch | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. PATCH can only be applied to the following fields: * `beforeProvisioningRule` * `description` * `ownerRef` A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed.
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.PatchServiceDeskIntegration(context.Background(), id).JsonPatch(jsonPatch).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.PatchServiceDeskIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PatchServiceDeskIntegration`: ServiceDeskIntegrationDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.PatchServiceDeskIntegration`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of the Service Desk integration to update |
Other parameters are passed through a pointer to a apiPatchServiceDeskIntegrationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
jsonPatch | JsonPatch | A list of SDIM update operations according to the JSON Patch standard. PATCH can only be applied to the following fields: * `beforeProvisioningRule` * `description` * `ownerRef` A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. |
UserContextAuth, UserContextAuth
- Content-Type: application/json-patch+json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
ServiceDeskIntegrationDto PutServiceDeskIntegration(ctx, id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()
Update a Service Desk integration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
id := "anId" // string | ID of the Service Desk integration to update
serviceDeskIntegrationDto := *openapiclient.NewServiceDeskIntegrationDto("aName", "A very nice Service Desk integration", "ServiceNowSDIM", map[string]interface{}{"key": interface{}(123)}) // ServiceDeskIntegrationDto | The specifics of the integration to update
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.PutServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.PutServiceDeskIntegration``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `PutServiceDeskIntegration`: ServiceDeskIntegrationDto
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.PutServiceDeskIntegration`: %v\n", resp)
}
Name | Type | Description | Notes |
---|---|---|---|
ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
id | string | ID of the Service Desk integration to update |
Other parameters are passed through a pointer to a apiPutServiceDeskIntegrationRequest struct via the builder pattern
Name | Type | Description | Notes |
---|
serviceDeskIntegrationDto | ServiceDeskIntegrationDto | The specifics of the integration to update |
UserContextAuth, UserContextAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
QueuedCheckConfigDetails UpdateStatusCheckDetails(ctx).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute()
Update the time check configuration
package main
import (
"context"
"fmt"
"os"
openapiclient "./openapi"
)
func main() {
queuedCheckConfigDetails := *openapiclient.NewQueuedCheckConfigDetails("30", "2") // QueuedCheckConfigDetails | the modified time check configuration
configuration := openapiclient.NewConfiguration()
apiClient := openapiclient.NewAPIClient(configuration)
resp, r, err := apiClient.ServiceDeskIntegrationApi.UpdateStatusCheckDetails(context.Background()).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute()
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.UpdateStatusCheckDetails``: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
// response from `UpdateStatusCheckDetails`: QueuedCheckConfigDetails
fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.UpdateStatusCheckDetails`: %v\n", resp)
}
Other parameters are passed through a pointer to a apiUpdateStatusCheckDetailsRequest struct via the builder pattern
Name | Type | Description | Notes |
---|---|---|---|
queuedCheckConfigDetails | QueuedCheckConfigDetails | the modified time check configuration |
UserContextAuth, UserContextAuth
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]