Skip to content

Latest commit

 

History

History
372 lines (230 loc) · 10.5 KB

File metadata and controls

372 lines (230 loc) · 10.5 KB

\IdpGroupMappingsAPI

All URIs are relative to https://api.opal.dev/v1

Method HTTP request Description
CreateIdpGroupMapping Post /idp-group-mappings/{app_resource_id}/groups/{group_id}
DeleteIdpGroupMappings Delete /idp-group-mappings/{app_resource_id}/groups/{group_id}
GetIdpGroupMapping Get /idp-group-mappings/{app_resource_id}/groups/{group_id}
GetIdpGroupMappings Get /idp-group-mappings/{app_resource_id}
UpdateIdpGroupMappings Put /idp-group-mappings/{app_resource_id}

CreateIdpGroupMapping

IdpGroupMapping CreateIdpGroupMapping(ctx, appResourceId, groupId).CreateIdpGroupMappingRequest(createIdpGroupMappingRequest).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	appResourceId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the Okta app.
	groupId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the group.
	createIdpGroupMappingRequest := *openapiclient.NewCreateIdpGroupMappingRequest() // CreateIdpGroupMappingRequest |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.IdpGroupMappingsAPI.CreateIdpGroupMapping(context.Background(), appResourceId, groupId).CreateIdpGroupMappingRequest(createIdpGroupMappingRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IdpGroupMappingsAPI.CreateIdpGroupMapping``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateIdpGroupMapping`: IdpGroupMapping
	fmt.Fprintf(os.Stdout, "Response from `IdpGroupMappingsAPI.CreateIdpGroupMapping`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appResourceId string The ID of the Okta app.
groupId string The ID of the group.

Other Parameters

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

Name Type Description Notes

createIdpGroupMappingRequest | CreateIdpGroupMappingRequest | |

Return type

IdpGroupMapping

Authorization

BearerAuth

HTTP request headers

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

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

DeleteIdpGroupMappings

DeleteIdpGroupMappings(ctx, appResourceId, groupId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	appResourceId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the Okta app.
	groupId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the group.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.IdpGroupMappingsAPI.DeleteIdpGroupMappings(context.Background(), appResourceId, groupId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IdpGroupMappingsAPI.DeleteIdpGroupMappings``: %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.
appResourceId string The ID of the Okta app.
groupId string The ID of the group.

Other Parameters

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

Name Type Description Notes

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

GetIdpGroupMapping

IdpGroupMapping GetIdpGroupMapping(ctx, appResourceId, groupId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	appResourceId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the Okta app.
	groupId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the group.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appResourceId string The ID of the Okta app.
groupId string The ID of the group.

Other Parameters

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

Name Type Description Notes

Return type

IdpGroupMapping

Authorization

BearerAuth

HTTP request headers

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

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

GetIdpGroupMappings

IdpGroupMappingList GetIdpGroupMappings(ctx, appResourceId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	appResourceId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the Okta app.

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

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
appResourceId string The ID of the Okta app.

Other Parameters

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

Name Type Description Notes

Return type

IdpGroupMappingList

Authorization

BearerAuth

HTTP request headers

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

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

UpdateIdpGroupMappings

UpdateIdpGroupMappings(ctx, appResourceId).UpdateIdpGroupMappingsRequest(updateIdpGroupMappingsRequest).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/opalsecurity/opal-go"
)

func main() {
	appResourceId := "4baf8423-db0a-4037-a4cf-f79c60cb67a5" // string | The ID of the Okta app.
	updateIdpGroupMappingsRequest := *openapiclient.NewUpdateIdpGroupMappingsRequest([]openapiclient.UpdateIdpGroupMappingsRequestMappingsInner{*openapiclient.NewUpdateIdpGroupMappingsRequestMappingsInner()}) // UpdateIdpGroupMappingsRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.IdpGroupMappingsAPI.UpdateIdpGroupMappings(context.Background(), appResourceId).UpdateIdpGroupMappingsRequest(updateIdpGroupMappingsRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `IdpGroupMappingsAPI.UpdateIdpGroupMappings``: %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.
appResourceId string The ID of the Okta app.

Other Parameters

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

Name Type Description Notes

updateIdpGroupMappingsRequest | UpdateIdpGroupMappingsRequest | |

Return type

(empty response body)

Authorization

BearerAuth

HTTP request headers

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

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