\ApiServiceIntegrationsAPI

All URIs are relative to https://subdomain.okta.com

Method	HTTP request	Description
ActivateApiServiceIntegrationInstanceSecret	Post /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/activate	Activate an API Service Integration instance Secret
CreateApiServiceIntegrationInstance	Post /integrations/api/v1/api-services	Create an API Service Integration instance
CreateApiServiceIntegrationInstanceSecret	Post /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets	Create an API Service Integration instance Secret
DeactivateApiServiceIntegrationInstanceSecret	Post /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}/lifecycle/deactivate	Deactivate an API Service Integration instance Secret
DeleteApiServiceIntegrationInstance	Delete /integrations/api/v1/api-services/{apiServiceId}	Delete an API Service Integration instance
DeleteApiServiceIntegrationInstanceSecret	Delete /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets/{secretId}	Delete an API Service Integration instance Secret
GetApiServiceIntegrationInstance	Get /integrations/api/v1/api-services/{apiServiceId}	Retrieve an API Service Integration instance
ListApiServiceIntegrationInstanceSecrets	Get /integrations/api/v1/api-services/{apiServiceId}/credentials/secrets	List all API Service Integration instance Secrets
ListApiServiceIntegrationInstances	Get /integrations/api/v1/api-services	List all API Service Integration instances

ActivateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret ActivateApiServiceIntegrationInstanceSecret(ctx, apiServiceId, secretId).Execute()

Activate an API Service Integration instance Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance
    secretId := "ocs2f4zrZbs8nUa7p0g4" // string | `id` of the API Service Integration instance Secret

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.ActivateApiServiceIntegrationInstanceSecret(context.Background(), apiServiceId, secretId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.ActivateApiServiceIntegrationInstanceSecret``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ActivateApiServiceIntegrationInstanceSecret`: APIServiceIntegrationInstanceSecret
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.ActivateApiServiceIntegrationInstanceSecret`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`id` of the API Service Integration instance Secret

Other Parameters

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

Name	Type	Description	Notes

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, 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]

CreateApiServiceIntegrationInstance

PostAPIServiceIntegrationInstance CreateApiServiceIntegrationInstance(ctx).PostAPIServiceIntegrationInstanceRequest(postAPIServiceIntegrationInstanceRequest).Execute()

Create an API Service Integration instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    postAPIServiceIntegrationInstanceRequest := *openapiclient.NewPostAPIServiceIntegrationInstanceRequest([]string{"GrantedScopes_example"}, "my_app_cie") // PostAPIServiceIntegrationInstanceRequest | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstance(context.Background()).PostAPIServiceIntegrationInstanceRequest(postAPIServiceIntegrationInstanceRequest).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateApiServiceIntegrationInstance`: PostAPIServiceIntegrationInstance
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstance`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
postAPIServiceIntegrationInstanceRequest	PostAPIServiceIntegrationInstanceRequest

Return type

PostAPIServiceIntegrationInstance

Authorization

apiToken

HTTP request headers

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

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

CreateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret CreateApiServiceIntegrationInstanceSecret(ctx, apiServiceId).Execute()

Create an API Service Integration instance Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstanceSecret(context.Background(), apiServiceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstanceSecret``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateApiServiceIntegrationInstanceSecret`: APIServiceIntegrationInstanceSecret
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.CreateApiServiceIntegrationInstanceSecret`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance

Other Parameters

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

Name	Type	Description	Notes

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, 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]

DeactivateApiServiceIntegrationInstanceSecret

APIServiceIntegrationInstanceSecret DeactivateApiServiceIntegrationInstanceSecret(ctx, apiServiceId, secretId).Execute()

Deactivate an API Service Integration instance Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance
    secretId := "ocs2f4zrZbs8nUa7p0g4" // string | `id` of the API Service Integration instance Secret

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.DeactivateApiServiceIntegrationInstanceSecret(context.Background(), apiServiceId, secretId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.DeactivateApiServiceIntegrationInstanceSecret``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeactivateApiServiceIntegrationInstanceSecret`: APIServiceIntegrationInstanceSecret
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.DeactivateApiServiceIntegrationInstanceSecret`: %v\n", resp)
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`id` of the API Service Integration instance Secret

Other Parameters

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

Name	Type	Description	Notes

Return type

APIServiceIntegrationInstanceSecret

Authorization

apiToken, 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]

DeleteApiServiceIntegrationInstance

DeleteApiServiceIntegrationInstance(ctx, apiServiceId).Execute()

Delete an API Service Integration instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApiServiceIntegrationsAPI.DeleteApiServiceIntegrationInstance(context.Background(), apiServiceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.DeleteApiServiceIntegrationInstance``: %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.
apiServiceId	string	`id` of the API Service Integration instance

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, 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]

DeleteApiServiceIntegrationInstanceSecret

DeleteApiServiceIntegrationInstanceSecret(ctx, apiServiceId, secretId).Execute()

Delete an API Service Integration instance Secret

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance
    secretId := "ocs2f4zrZbs8nUa7p0g4" // string | `id` of the API Service Integration instance Secret

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApiServiceIntegrationsAPI.DeleteApiServiceIntegrationInstanceSecret(context.Background(), apiServiceId, secretId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.DeleteApiServiceIntegrationInstanceSecret``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance
secretId	string	`id` of the API Service Integration instance Secret

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

apiToken, 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]

GetApiServiceIntegrationInstance

APIServiceIntegrationInstance GetApiServiceIntegrationInstance(ctx, apiServiceId).Execute()

Retrieve an API Service Integration instance

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.GetApiServiceIntegrationInstance(context.Background(), apiServiceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.GetApiServiceIntegrationInstance``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetApiServiceIntegrationInstance`: APIServiceIntegrationInstance
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.GetApiServiceIntegrationInstance`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance

Other Parameters

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

Name	Type	Description	Notes

Return type

APIServiceIntegrationInstance

Authorization

apiToken, 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]

ListApiServiceIntegrationInstanceSecrets

[]APIServiceIntegrationInstanceSecret ListApiServiceIntegrationInstanceSecrets(ctx, apiServiceId).Execute()

List all API Service Integration instance Secrets

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    apiServiceId := "000lr2rLjZ6NsGn1P0g3" // string | `id` of the API Service Integration instance

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstanceSecrets(context.Background(), apiServiceId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstanceSecrets``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListApiServiceIntegrationInstanceSecrets`: []APIServiceIntegrationInstanceSecret
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstanceSecrets`: %v\n", resp)
}

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
apiServiceId	string	`id` of the API Service Integration instance

Other Parameters

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

Name	Type	Description	Notes

Return type

[]APIServiceIntegrationInstanceSecret

Authorization

apiToken, 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]

ListApiServiceIntegrationInstances

[]APIServiceIntegrationInstance ListApiServiceIntegrationInstances(ctx).After(after).Execute()

List all API Service Integration instances

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/okta/okta-sdk-golang"
)

func main() {
    after := "after_example" // string | The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination). (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstances(context.Background()).After(after).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstances``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListApiServiceIntegrationInstances`: []APIServiceIntegrationInstance
    fmt.Fprintf(os.Stdout, "Response from `ApiServiceIntegrationsAPI.ListApiServiceIntegrationInstances`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
after	string	The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See Pagination.

Return type

[]APIServiceIntegrationInstance

Authorization

apiToken, 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]

Files

ApiServiceIntegrationsAPI.md

Latest commit

History

ApiServiceIntegrationsAPI.md

File metadata and controls

\ApiServiceIntegrationsAPI

ActivateApiServiceIntegrationInstanceSecret

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateApiServiceIntegrationInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateApiServiceIntegrationInstanceSecret

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeactivateApiServiceIntegrationInstanceSecret

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApiServiceIntegrationInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApiServiceIntegrationInstanceSecret

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetApiServiceIntegrationInstance

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApiServiceIntegrationInstanceSecrets

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApiServiceIntegrationInstances

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers