Skip to content

Latest commit

 

History

History
698 lines (443 loc) · 24.7 KB

ServiceDeskIntegrationApi.md

File metadata and controls

698 lines (443 loc) · 24.7 KB
Raw

\ServiceDeskIntegrationApi

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

Method HTTP request Description
CreateServiceDeskIntegration Post /service-desk-integrations Create a new Service Desk integration
DeleteServiceDeskIntegration Delete /service-desk-integrations/{id} Delete a Service Desk integration by ID
GetServiceDeskIntegration Get /service-desk-integrations/{id} Get a Service Desk integration by ID
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 of queued SDIM tickets
PatchServiceDeskIntegration Patch /service-desk-integrations/{id} Service Desk Integration Update - PATCH
UpdateServiceDeskIntegration Put /service-desk-integrations/{id} Update a Service Desk integration by ID
UpdateStatusCheckDetails Put /service-desk-integrations/status-check-configuration Update the time check configuration of queued SDIM tickets

CreateServiceDeskIntegration

ServiceDeskIntegrationDto CreateServiceDeskIntegration(ctx).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()

Create a new Service Desk integration

Example

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

Path Parameters

Other Parameters

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

Return type

ServiceDeskIntegrationDto

Authorization

oauth2, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteServiceDeskIntegration

DeleteServiceDeskIntegration(ctx, id).Execute()

Delete a Service Desk integration by ID

Example

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

Path Parameters

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

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

Name Type Description Notes

Return type

(empty response body)

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceDeskIntegration

ServiceDeskIntegrationDto GetServiceDeskIntegration(ctx, id).Execute()

Get a Service Desk integration by ID

Example

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

Path Parameters

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

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

Name Type Description Notes

Return type

ServiceDeskIntegrationDto

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceDeskIntegrationList

[]ServiceDeskIntegrationDto GetServiceDeskIntegrationList(ctx).Offset(offset).Limit(limit).Sorters(sorters).Filters(filters).Count(count).Execute()

List existing Service Desk Integrations

Example

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 := "sorters_example" // 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 := "filters_example" // 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)
}

Path Parameters

Other Parameters

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]

Return type

[]ServiceDeskIntegrationDto

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceDeskIntegrationTemplate

ServiceDeskIntegrationTemplateDto GetServiceDeskIntegrationTemplate(ctx, scriptName).Execute()

Service Desk integration template by scriptName.

Example

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

Path Parameters

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

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

Name Type Description Notes

Return type

ServiceDeskIntegrationTemplateDto

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetServiceDeskIntegrationTypes

[]ServiceDeskIntegrationTemplateType GetServiceDeskIntegrationTypes(ctx).Execute()

Service Desk Integration Types List.

Example

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

[]ServiceDeskIntegrationTemplateType

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatusCheckDetails

QueuedCheckConfigDetails GetStatusCheckDetails(ctx).Execute()

Get the time check configuration of queued SDIM tickets

Example

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

Path Parameters

This endpoint does not need any parameter.

Other Parameters

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

Return type

QueuedCheckConfigDetails

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PatchServiceDeskIntegration

ServiceDeskIntegrationDto PatchServiceDeskIntegration(ctx, id).JsonPatch(jsonPatch).Execute()

Service Desk Integration Update - PATCH

Example

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

Path Parameters

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

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" A 403 Forbidden Error indicates that you attempted to PATCH a field that is not allowed. |

Return type

ServiceDeskIntegrationDto

Authorization

oauth2, oauth2

HTTP request headers

  • Content-Type: application/json-patch+json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateServiceDeskIntegration

ServiceDeskIntegrationDto UpdateServiceDeskIntegration(ctx, id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()

Update a Service Desk integration by ID

Example

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.UpdateServiceDeskIntegration(context.Background(), id).ServiceDeskIntegrationDto(serviceDeskIntegrationDto).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ServiceDeskIntegrationApi.UpdateServiceDeskIntegration``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateServiceDeskIntegration`: ServiceDeskIntegrationDto
    fmt.Fprintf(os.Stdout, "Response from `ServiceDeskIntegrationApi.UpdateServiceDeskIntegration`: %v\n", resp)
}

Path Parameters

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

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

Name Type Description Notes

serviceDeskIntegrationDto | ServiceDeskIntegrationDto | The specifics of the integration to update |

Return type

ServiceDeskIntegrationDto

Authorization

oauth2, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateStatusCheckDetails

QueuedCheckConfigDetails UpdateStatusCheckDetails(ctx).QueuedCheckConfigDetails(queuedCheckConfigDetails).Execute()

Update the time check configuration of queued SDIM tickets

Example

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

Path Parameters

Other Parameters

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

Return type

QueuedCheckConfigDetails

Authorization

oauth2, oauth2

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]