Skip to content

Latest commit

 

History

History
1304 lines (825 loc) · 39.5 KB

RoleTargetAPI.md

File metadata and controls

1304 lines (825 loc) · 39.5 KB

\RoleTargetAPI

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

Method HTTP request Description
AssignAllAppsAsTargetToRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps Assign all Apps as Target to Role
AssignAppInstanceTargetToAppAdminRoleForGroup Put /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId} Assign an Application Instance Target to Application Administrator Role
AssignAppInstanceTargetToAppAdminRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId} Assign an Application Instance Target to an Application Administrator Role
AssignAppTargetToAdminRoleForGroup Put /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} Assign an Application Target to Administrator Role
AssignAppTargetToAdminRoleForUser Put /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName} Assign an Application Target to Administrator Role
AssignGroupTargetToGroupAdminRole Put /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} Assign a Group Target to a Group Role
AssignGroupTargetToUserRole Put /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} Assign a Group Target to Role
ListApplicationTargetsForApplicationAdministratorRoleForGroup Get /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps List all Application Targets for an Application Administrator Role
ListApplicationTargetsForApplicationAdministratorRoleForUser Get /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps List all Application Targets for Application Administrator Role
ListGroupTargetsForGroupRole Get /api/v1/groups/{groupId}/roles/{roleId}/targets/groups List all Group Targets for a Group Role
ListGroupTargetsForRole Get /api/v1/users/{userId}/roles/{roleId}/targets/groups List all Group Targets for Role
UnassignAppInstanceTargetFromAdminRoleForUser Delete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId} Unassign an Application Instance Target from an Application Administrator Role
UnassignAppInstanceTargetToAppAdminRoleForGroup Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName}/{appId} Unassign an Application Instance Target from an Application Administrator Role
UnassignAppTargetFromAppAdminRoleForUser Delete /api/v1/users/{userId}/roles/{roleId}/targets/catalog/apps/{appName} Unassign an Application Target from an Application Administrator Role
UnassignAppTargetToAdminRoleForGroup Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/catalog/apps/{appName} Unassign an Application Target from Application Administrator Role
UnassignGroupTargetFromGroupAdminRole Delete /api/v1/groups/{groupId}/roles/{roleId}/targets/groups/{targetGroupId} Unassign a Group Target from a Group Role
UnassignGroupTargetFromUserAdminRole Delete /api/v1/users/{userId}/roles/{roleId}/targets/groups/{groupId} Unassign a Group Target from Role

AssignAllAppsAsTargetToRoleForUser

AssignAllAppsAsTargetToRoleForUser(ctx, userId, roleId).Execute()

Assign all Apps as Target to Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role

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

Other Parameters

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

AssignAppInstanceTargetToAppAdminRoleForGroup

AssignAppInstanceTargetToAppAdminRoleForGroup(ctx, groupId, roleId, appName, appId).Execute()

Assign an Application Instance Target to Application Administrator Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignAppInstanceTargetToAppAdminRoleForGroup(context.Background(), groupId, roleId, appName, appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignAppInstanceTargetToAppAdminRoleForGroup``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
appName string
appId string Application ID

Other Parameters

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

AssignAppInstanceTargetToAppAdminRoleForUser

AssignAppInstanceTargetToAppAdminRoleForUser(ctx, userId, roleId, appName, appId).Execute()

Assign an Application Instance Target to an Application Administrator Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignAppInstanceTargetToAppAdminRoleForUser(context.Background(), userId, roleId, appName, appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignAppInstanceTargetToAppAdminRoleForUser``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
appName string
appId string Application ID

Other Parameters

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

AssignAppTargetToAdminRoleForGroup

AssignAppTargetToAdminRoleForGroup(ctx, groupId, roleId, appName).Execute()

Assign an Application Target to Administrator Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignAppTargetToAdminRoleForGroup(context.Background(), groupId, roleId, appName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignAppTargetToAdminRoleForGroup``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
appName string

Other Parameters

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

AssignAppTargetToAdminRoleForUser

AssignAppTargetToAdminRoleForUser(ctx, userId, roleId, appName).Execute()

Assign an Application Target to Administrator Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignAppTargetToAdminRoleForUser(context.Background(), userId, roleId, appName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignAppTargetToAdminRoleForUser``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
appName string

Other Parameters

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

AssignGroupTargetToGroupAdminRole

AssignGroupTargetToGroupAdminRole(ctx, groupId, roleId, targetGroupId).Execute()

Assign a Group Target to a Group Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    targetGroupId := "00g1e9dfjHeLAsdX983d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignGroupTargetToGroupAdminRole(context.Background(), groupId, roleId, targetGroupId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignGroupTargetToGroupAdminRole``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
targetGroupId string

Other Parameters

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

AssignGroupTargetToUserRole

AssignGroupTargetToUserRole(ctx, userId, roleId, groupId).Execute()

Assign a Group Target to Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.AssignGroupTargetToUserRole(context.Background(), userId, roleId, groupId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.AssignGroupTargetToUserRole``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
groupId string The `id` of the group

Other Parameters

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

ListApplicationTargetsForApplicationAdministratorRoleForGroup

[]CatalogApplication ListApplicationTargetsForApplicationAdministratorRoleForGroup(ctx, groupId, roleId).After(after).Limit(limit).Execute()

List all Application Targets for an Application Administrator Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    after := "after_example" // string |  (optional)
    limit := int32(56) // int32 |  (optional) (default to 20)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The `id` of the group
roleId string `id` of the Role

Other Parameters

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

Name Type Description Notes

after | string | | limit | int32 | | [default to 20]

Return type

[]CatalogApplication

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]

ListApplicationTargetsForApplicationAdministratorRoleForUser

[]CatalogApplication ListApplicationTargetsForApplicationAdministratorRoleForUser(ctx, userId, roleId).After(after).Limit(limit).Execute()

List all Application Targets for Application Administrator Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    after := "after_example" // string |  (optional)
    limit := int32(56) // int32 |  (optional) (default to 20)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ID of an existing Okta user
roleId string `id` of the Role

Other Parameters

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

Name Type Description Notes

after | string | | limit | int32 | | [default to 20]

Return type

[]CatalogApplication

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]

ListGroupTargetsForGroupRole

[]Group ListGroupTargetsForGroupRole(ctx, groupId, roleId).After(after).Limit(limit).Execute()

List all Group Targets for a Group Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    after := "after_example" // string |  (optional)
    limit := int32(56) // int32 |  (optional) (default to 20)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string The `id` of the group
roleId string `id` of the Role

Other Parameters

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

Name Type Description Notes

after | string | | limit | int32 | | [default to 20]

Return type

[]Group

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]

ListGroupTargetsForRole

[]Group ListGroupTargetsForRole(ctx, userId, roleId).After(after).Limit(limit).Execute()

List all Group Targets for Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    after := "after_example" // string |  (optional)
    limit := int32(56) // int32 |  (optional) (default to 20)

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
userId string ID of an existing Okta user
roleId string `id` of the Role

Other Parameters

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

Name Type Description Notes

after | string | | limit | int32 | | [default to 20]

Return type

[]Group

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]

UnassignAppInstanceTargetFromAdminRoleForUser

UnassignAppInstanceTargetFromAdminRoleForUser(ctx, userId, roleId, appName, appId).Execute()

Unassign an Application Instance Target from an Application Administrator Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignAppInstanceTargetFromAdminRoleForUser(context.Background(), userId, roleId, appName, appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignAppInstanceTargetFromAdminRoleForUser``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
appName string
appId string Application ID

Other Parameters

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

UnassignAppInstanceTargetToAppAdminRoleForGroup

UnassignAppInstanceTargetToAppAdminRoleForGroup(ctx, groupId, roleId, appName, appId).Execute()

Unassign an Application Instance Target from an Application Administrator Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 
    appId := "0oafxqCAJWWGELFTYASJ" // string | Application ID

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignAppInstanceTargetToAppAdminRoleForGroup(context.Background(), groupId, roleId, appName, appId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignAppInstanceTargetToAppAdminRoleForGroup``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
appName string
appId string Application ID

Other Parameters

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

UnassignAppTargetFromAppAdminRoleForUser

UnassignAppTargetFromAppAdminRoleForUser(ctx, userId, roleId, appName).Execute()

Unassign an Application Target from an Application Administrator Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignAppTargetFromAppAdminRoleForUser(context.Background(), userId, roleId, appName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignAppTargetFromAppAdminRoleForUser``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
appName string

Other Parameters

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

UnassignAppTargetToAdminRoleForGroup

UnassignAppTargetToAdminRoleForGroup(ctx, groupId, roleId, appName).Execute()

Unassign an Application Target from Application Administrator Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    appName := "oidc_client" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignAppTargetToAdminRoleForGroup(context.Background(), groupId, roleId, appName).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignAppTargetToAdminRoleForGroup``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
appName string

Other Parameters

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

UnassignGroupTargetFromGroupAdminRole

UnassignGroupTargetFromGroupAdminRole(ctx, groupId, roleId, targetGroupId).Execute()

Unassign a Group Target from a Group Role

Example

package main

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

func main() {
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    targetGroupId := "00g1e9dfjHeLAsdX983d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignGroupTargetFromGroupAdminRole(context.Background(), groupId, roleId, targetGroupId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignGroupTargetFromGroupAdminRole``: %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.
groupId string The `id` of the group
roleId string `id` of the Role
targetGroupId string

Other Parameters

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

UnassignGroupTargetFromUserAdminRole

UnassignGroupTargetFromUserAdminRole(ctx, userId, roleId, groupId).Execute()

Unassign a Group Target from Role

Example

package main

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

func main() {
    userId := "userId_example" // string | ID of an existing Okta user
    roleId := "3Vg1Pjp3qzw4qcCK5EdO" // string | `id` of the Role
    groupId := "00g1emaKYZTWRYYRRTSK" // string | The `id` of the group

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    r, err := apiClient.RoleTargetAPI.UnassignGroupTargetFromUserAdminRole(context.Background(), userId, roleId, groupId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `RoleTargetAPI.UnassignGroupTargetFromUserAdminRole``: %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.
userId string ID of an existing Okta user
roleId string `id` of the Role
groupId string The `id` of the group

Other Parameters

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