\ApplicationAPI

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

Method	HTTP request	Description
ActivateApplication	Post /api/v1/apps/{appId}/lifecycle/activate	Activate an Application
CreateApplication	Post /api/v1/apps	Create an Application
DeactivateApplication	Post /api/v1/apps/{appId}/lifecycle/deactivate	Deactivate an Application
DeleteApplication	Delete /api/v1/apps/{appId}	Delete an Application
GetApplication	Get /api/v1/apps/{appId}	Retrieve an Application
ListApplications	Get /api/v1/apps	List all Applications
ReplaceApplication	Put /api/v1/apps/{appId}	Replace an Application

ActivateApplication

ActivateApplication(ctx, appId).Execute()

Activate an Application

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApplicationAPI.ActivateApplication(context.Background(), appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.ActivateApplication``: %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.
appId	string	Application ID

Other Parameters

Other parameters are passed through a pointer to a apiActivateApplicationRequest 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]

CreateApplication

ListApplications200ResponseInner CreateApplication(ctx).Application(application).Activate(activate).OktaAccessGatewayAgent(oktaAccessGatewayAgent).Execute()

Create an Application

Example

package main

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

func main() {
    application := openapiclient.listApplications_200_response_inner{AutoLoginApplication: openapiclient.NewAutoLoginApplication()} // ListApplications200ResponseInner | 
    activate := true // bool | Executes activation lifecycle operation when creating the app (optional) (default to true)
    oktaAccessGatewayAgent := "oktaAccessGatewayAgent_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApplicationAPI.CreateApplication(context.Background()).Application(application).Activate(activate).OktaAccessGatewayAgent(oktaAccessGatewayAgent).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.CreateApplication``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateApplication`: ListApplications200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `ApplicationAPI.CreateApplication`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
application	ListApplications200ResponseInner
activate	bool	Executes activation lifecycle operation when creating the app	[default to true]
oktaAccessGatewayAgent	string

Return type

ListApplications200ResponseInner

Authorization

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

DeactivateApplication

DeactivateApplication(ctx, appId).Execute()

Deactivate an Application

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApplicationAPI.DeactivateApplication(context.Background(), appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.DeactivateApplication``: %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.
appId	string	Application ID

Other Parameters

Other parameters are passed through a pointer to a apiDeactivateApplicationRequest 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]

DeleteApplication

DeleteApplication(ctx, appId).Execute()

Delete an Application

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApplicationAPI.DeleteApplication(context.Background(), appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.DeleteApplication``: %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.
appId	string	Application ID

Other Parameters

Other parameters are passed through a pointer to a apiDeleteApplicationRequest 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]

GetApplication

ListApplications200ResponseInner GetApplication(ctx, appId).Expand(expand).Execute()

Retrieve an Application

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    expand := "expand_example" // string |  (optional)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string	Application ID

Other Parameters

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

Name	Type	Description	Notes

expand | string | |

Return type

ListApplications200ResponseInner

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]

ListApplications

[]ListApplications200ResponseInner ListApplications(ctx).Q(q).After(after).Limit(limit).Filter(filter).Expand(expand).IncludeNonDeleted(includeNonDeleted).Execute()

List all Applications

Example

package main

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

func main() {
    q := "q_example" // string |  (optional)
    after := "after_example" // string | Specifies the pagination cursor for the next page of apps (optional)
    limit := int32(56) // int32 | Specifies the number of results for a page (optional) (default to -1)
    filter := "filter_example" // string | Filters apps by status, user.id, group.id or credentials.signing.kid expression (optional)
    expand := "expand_example" // string | Traverses users link relationship and optionally embeds Application User resource (optional)
    includeNonDeleted := true // bool |  (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApplicationAPI.ListApplications(context.Background()).Q(q).After(after).Limit(limit).Filter(filter).Expand(expand).IncludeNonDeleted(includeNonDeleted).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationAPI.ListApplications``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListApplications`: []ListApplications200ResponseInner
    fmt.Fprintf(os.Stdout, "Response from `ApplicationAPI.ListApplications`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name	Type	Description	Notes
q	string
after	string	Specifies the pagination cursor for the next page of apps
limit	int32	Specifies the number of results for a page	[default to -1]
filter	string	Filters apps by status, user.id, group.id or credentials.signing.kid expression
expand	string	Traverses users link relationship and optionally embeds Application User resource
includeNonDeleted	bool		[default to false]

Return type

[]ListApplications200ResponseInner

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]

ReplaceApplication

ListApplications200ResponseInner ReplaceApplication(ctx, appId).Application(application).Execute()

Replace an Application

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    application := openapiclient.listApplications_200_response_inner{AutoLoginApplication: openapiclient.NewAutoLoginApplication()} // ListApplications200ResponseInner | 

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
appId	string	Application ID

Other Parameters

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

Name	Type	Description	Notes

application | ListApplications200ResponseInner | |

Return type

ListApplications200ResponseInner

Authorization

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

Files

ApplicationAPI.md

Latest commit

History

ApplicationAPI.md

File metadata and controls

\ApplicationAPI

ActivateApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

CreateApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeactivateApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListApplications

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ReplaceApplication

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers