Skip to content

Latest commit

 

History

History
392 lines (255 loc) · 11.7 KB

ApplicationUsersAPI.md

File metadata and controls

392 lines (255 loc) · 11.7 KB
Raw

\ApplicationUsersAPI

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

Method HTTP request Description
AssignUserToApplication Post /api/v1/apps/{appId}/users Assign a User
GetApplicationUser Get /api/v1/apps/{appId}/users/{userId} Retrieve an assigned User
ListApplicationUsers Get /api/v1/apps/{appId}/users List all assigned Users
UnassignUserFromApplication Delete /api/v1/apps/{appId}/users/{userId} Unassign an App User
UpdateApplicationUser Post /api/v1/apps/{appId}/users/{userId} Update an App Profile for an assigned User

AssignUserToApplication

AppUser AssignUserToApplication(ctx, appId).AppUser(appUser).Execute()

Assign a User

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    appUser := *openapiclient.NewAppUser("TODO", "TODO", "USER", "ACTIVE", time.Now(), *openapiclient.NewLinksAppAndUser()) // AppUser | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApplicationUsersAPI.AssignUserToApplication(context.Background(), appId).AppUser(appUser).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationUsersAPI.AssignUserToApplication``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AssignUserToApplication`: AppUser
    fmt.Fprintf(os.Stdout, "Response from `ApplicationUsersAPI.AssignUserToApplication`: %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 apiAssignUserToApplicationRequest struct via the builder pattern

Name Type Description Notes

appUser | AppUser | |

Return type

AppUser

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]

GetApplicationUser

AppUser GetApplicationUser(ctx, appId, userId).Expand(expand).Execute()

Retrieve an assigned User

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    userId := "userId_example" // string | ID of an existing Okta user
    expand := "expand_example" // string |  (optional)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appId string Application ID
userId string ID of an existing Okta user

Other Parameters

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

Name Type Description Notes

expand | string | |

Return type

AppUser

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]

ListApplicationUsers

[]AppUser ListApplicationUsers(ctx, appId).Q(q).QueryScope(queryScope).After(after).Limit(limit).Filter(filter).Expand(expand).Execute()

List all assigned Users

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    q := "q_example" // string |  (optional)
    queryScope := "queryScope_example" // string |  (optional)
    after := "after_example" // string | specifies the pagination cursor for the next page of assignments (optional)
    limit := int32(56) // int32 | specifies the number of results for a page (optional) (default to -1)
    filter := "filter_example" // string |  (optional)
    expand := "expand_example" // string |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.ApplicationUsersAPI.ListApplicationUsers(context.Background(), appId).Q(q).QueryScope(queryScope).After(after).Limit(limit).Filter(filter).Expand(expand).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationUsersAPI.ListApplicationUsers``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `ListApplicationUsers`: []AppUser
    fmt.Fprintf(os.Stdout, "Response from `ApplicationUsersAPI.ListApplicationUsers`: %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 apiListApplicationUsersRequest struct via the builder pattern

Name Type Description Notes

q | string | | queryScope | string | | after | string | specifies the pagination cursor for the next page of assignments | limit | int32 | specifies the number of results for a page | [default to -1] filter | string | | expand | string | |

Return type

[]AppUser

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]

UnassignUserFromApplication

UnassignUserFromApplication(ctx, appId, userId).SendEmail(sendEmail).Execute()

Unassign an App User

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    userId := "userId_example" // string | ID of an existing Okta user
    sendEmail := true // bool |  (optional) (default to false)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.ApplicationUsersAPI.UnassignUserFromApplication(context.Background(), appId, userId).SendEmail(sendEmail).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `ApplicationUsersAPI.UnassignUserFromApplication``: %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
userId string ID of an existing Okta user

Other Parameters

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

Name Type Description Notes

sendEmail | bool | | [default to false]

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]

UpdateApplicationUser

AppUser UpdateApplicationUser(ctx, appId, userId).AppUser(appUser).Execute()

Update an App Profile for an assigned User

Example

package main

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

func main() {
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID
    userId := "userId_example" // string | ID of an existing Okta user
    appUser := *openapiclient.NewAppUser("TODO", "TODO", "USER", "ACTIVE", time.Now(), *openapiclient.NewLinksAppAndUser()) // AppUser | 

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appId string Application ID
userId string ID of an existing Okta user

Other Parameters

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

Name Type Description Notes

appUser | AppUser | |

Return type

AppUser

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]