\AuthenticationManagementAPI

All URIs are relative to https://keycloak.example.com/admin/realms

Method	HTTP request	Description
DeleteConfig	Delete /{realm}/authentication/config/{id}
DeleteExecution	Delete /{realm}/authentication/executions/{executionId}
DeleteFlow	Delete /{realm}/authentication/flows/{id}
DeleteRequiredAction	Delete /{realm}/authentication/required-actions/{alias}
GetAuthenticationConfig	Get /{realm}/authentication/config/{id}
GetAuthenticatorProviders	Get /{realm}/authentication/authenticator-providers
GetClientAuthenticatorProviders	Get /{realm}/authentication/client-authenticator-providers
GetConfigDescription	Get /{realm}/authentication/config-description/{providerId}
GetExecution	Get /{realm}/authentication/executions/{executionId}
GetExecutionConfig	Get /{realm}/authentication/executions/{executionId}/config/{id}
GetExecutions	Get /{realm}/authentication/flows/{flowAlias}/executions
GetFlow	Get /{realm}/authentication/flows/{id}
GetFlows	Get /{realm}/authentication/flows
GetFormActionProviders	Get /{realm}/authentication/form-action-providers
GetFormProviders	Get /{realm}/authentication/form-providers
GetPerClientConfigDescription	Get /{realm}/authentication/per-client-config-description
GetRequiredAction	Get /{realm}/authentication/required-actions/{alias}
GetRequiredActions	Get /{realm}/authentication/required-actions
GetUnregisteredRequiredActions	Get /{realm}/authentication/unregistered-required-actions
PostAuthenticationConfig	Post /{realm}/authentication/config
PostCopy	Post /{realm}/authentication/flows/{flowAlias}/copy
PostExecution	Post /{realm}/authentication/flows/{flowAlias}/executions/execution
PostExecutionConfig	Post /{realm}/authentication/executions/{executionId}/config
PostExecutionLowerPriority	Post /{realm}/authentication/executions/{executionId}/lower-priority
PostExecutionRaisePriority	Post /{realm}/authentication/executions/{executionId}/raise-priority
PostExecutions	Post /{realm}/authentication/executions
PostFlow	Post /{realm}/authentication/flows/{flowAlias}/executions/flow
PostFlows	Post /{realm}/authentication/flows
PostRegisterRequiredAction	Post /{realm}/authentication/register-required-action
PostRequiredActionLowerPriority	Post /{realm}/authentication/required-actions/{alias}/lower-priority
PostRequiredActionRaisePriority	Post /{realm}/authentication/required-actions/{alias}/raise-priority
PutAuthenticationConfig	Put /{realm}/authentication/config/{id}
PutExecutions	Put /{realm}/authentication/flows/{flowAlias}/executions
PutFlow	Put /{realm}/authentication/flows/{id}
PutRequiredAction	Put /{realm}/authentication/required-actions/{alias}

DeleteConfig

DeleteConfig(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | Configuration id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.DeleteConfig(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.DeleteConfig``: %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.
realm	string	realm name (not id!)
id	string	Configuration id

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

DeleteExecution

DeleteExecution(ctx, realm, executionId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.DeleteExecution(context.Background(), realm, executionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.DeleteExecution``: %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.
realm	string	realm name (not id!)
executionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

DeleteFlow

DeleteFlow(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.DeleteFlow(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.DeleteFlow``: %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.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

DeleteRequiredAction

DeleteRequiredAction(ctx, realm, alias).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	alias := "alias_example" // string | Alias of required action

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.DeleteRequiredAction(context.Background(), realm, alias).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.DeleteRequiredAction``: %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.
realm	string	realm name (not id!)
alias	string	Alias of required action

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GetAuthenticationConfig

AuthenticatorConfigRepresentation GetAuthenticationConfig(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | Configuration id

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string	Configuration id

Other Parameters

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

Name	Type	Description	Notes

Return type

AuthenticatorConfigRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetAuthenticatorProviders

[]map[string]interface{} GetAuthenticatorProviders(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]map[string]interface{}

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetClientAuthenticatorProviders

[]map[string]interface{} GetClientAuthenticatorProviders(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]map[string]interface{}

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetConfigDescription

AuthenticatorConfigInfoRepresentation GetConfigDescription(ctx, realm, providerId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	providerId := "providerId_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
providerId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

AuthenticatorConfigInfoRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetExecution

GetExecution(ctx, realm, executionId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.GetExecution(context.Background(), realm, executionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.GetExecution``: %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.
realm	string	realm name (not id!)
executionId	string

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GetExecutionConfig

AuthenticatorConfigRepresentation GetExecutionConfig(ctx, realm, executionId, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | Execution id
	id := "id_example" // string | Configuration id

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
executionId	string	Execution id
id	string	Configuration id

Other Parameters

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

Name	Type	Description	Notes

Return type

AuthenticatorConfigRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetExecutions

GetExecutions(ctx, realm, flowAlias).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	flowAlias := "flowAlias_example" // string | Flow alias

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.GetExecutions(context.Background(), realm, flowAlias).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.GetExecutions``: %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.
realm	string	realm name (not id!)
flowAlias	string	Flow alias

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

GetFlow

AuthenticationFlowRepresentation GetFlow(ctx, realm, id).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

Return type

AuthenticationFlowRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetFlows

[]AuthenticationFlowRepresentation GetFlows(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]AuthenticationFlowRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetFormActionProviders

[]map[string]interface{} GetFormActionProviders(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]map[string]interface{}

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetFormProviders

[]map[string]interface{} GetFormProviders(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]map[string]interface{}

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetPerClientConfigDescription

map[string]ConfigPropertyRepresentation GetPerClientConfigDescription(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

map[string]ConfigPropertyRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetRequiredAction

RequiredActionProviderRepresentation GetRequiredAction(ctx, realm, alias).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	alias := "alias_example" // string | Alias of required action

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

Path Parameters

Name	Type	Description
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)
alias	string	Alias of required action

Other Parameters

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

Name	Type	Description	Notes

Return type

RequiredActionProviderRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetRequiredActions

[]RequiredActionProviderRepresentation GetRequiredActions(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]RequiredActionProviderRepresentation

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetUnregisteredRequiredActions

[]string GetUnregisteredRequiredActions(ctx, realm).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)

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

Path Parameters

Name	Type	Description	Notes
ctx	context.Context	context for authentication, logging, cancellation, deadlines, tracing, etc.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

Return type

[]string

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

PostAuthenticationConfig

PostAuthenticationConfig(ctx, realm).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	authenticatorConfigRepresentation := *openapiclient.NewAuthenticatorConfigRepresentation() // AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostAuthenticationConfig(context.Background(), realm).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostAuthenticationConfig``: %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.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

authenticatorConfigRepresentation | AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostCopy

PostCopy(ctx, realm, flowAlias).Body(body).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	flowAlias := "flowAlias_example" // string | name of the existing authentication flow
	body := "body_example" // string | [string] (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostCopy(context.Background(), realm, flowAlias).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostCopy``: %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.
realm	string	realm name (not id!)
flowAlias	string	name of the existing authentication flow

Other Parameters

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

Name	Type	Description	Notes

body | string | [string] |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostExecution

PostExecution(ctx, realm, flowAlias).Body(body).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	flowAlias := "flowAlias_example" // string | Alias of parent flow
	body := "body_example" // string | [string] (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostExecution(context.Background(), realm, flowAlias).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostExecution``: %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.
realm	string	realm name (not id!)
flowAlias	string	Alias of parent flow

Other Parameters

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

Name	Type	Description	Notes

body | string | [string] |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostExecutionConfig

PostExecutionConfig(ctx, realm, executionId).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | Execution id
	authenticatorConfigRepresentation := *openapiclient.NewAuthenticatorConfigRepresentation() // AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostExecutionConfig(context.Background(), realm, executionId).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostExecutionConfig``: %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.
realm	string	realm name (not id!)
executionId	string	Execution id

Other Parameters

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

Name	Type	Description	Notes

authenticatorConfigRepresentation | AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostExecutionLowerPriority

PostExecutionLowerPriority(ctx, realm, executionId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | Execution id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostExecutionLowerPriority(context.Background(), realm, executionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostExecutionLowerPriority``: %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.
realm	string	realm name (not id!)
executionId	string	Execution id

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

PostExecutionRaisePriority

PostExecutionRaisePriority(ctx, realm, executionId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	executionId := "executionId_example" // string | Execution id

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostExecutionRaisePriority(context.Background(), realm, executionId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostExecutionRaisePriority``: %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.
realm	string	realm name (not id!)
executionId	string	Execution id

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

PostExecutions

PostExecutions(ctx, realm).AuthenticationExecutionRepresentation(authenticationExecutionRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	authenticationExecutionRepresentation := *openapiclient.NewAuthenticationExecutionRepresentation() // AuthenticationExecutionRepresentation | AuthenticationExecutionRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostExecutions(context.Background(), realm).AuthenticationExecutionRepresentation(authenticationExecutionRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostExecutions``: %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.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

authenticationExecutionRepresentation | AuthenticationExecutionRepresentation | AuthenticationExecutionRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostFlow

PostFlow(ctx, realm, flowAlias).Body(body).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	flowAlias := "flowAlias_example" // string | Alias of parent authentication flow
	body := "body_example" // string | [string] (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostFlow(context.Background(), realm, flowAlias).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostFlow``: %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.
realm	string	realm name (not id!)
flowAlias	string	Alias of parent authentication flow

Other Parameters

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

Name	Type	Description	Notes

body | string | [string] |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostFlows

PostFlows(ctx, realm).AuthenticationFlowRepresentation(authenticationFlowRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	authenticationFlowRepresentation := *openapiclient.NewAuthenticationFlowRepresentation() // AuthenticationFlowRepresentation | AuthenticationFlowRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostFlows(context.Background(), realm).AuthenticationFlowRepresentation(authenticationFlowRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostFlows``: %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.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

authenticationFlowRepresentation | AuthenticationFlowRepresentation | AuthenticationFlowRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostRegisterRequiredAction

PostRegisterRequiredAction(ctx, realm).Body(body).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	body := "body_example" // string | [string] (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostRegisterRequiredAction(context.Background(), realm).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostRegisterRequiredAction``: %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.
realm	string	realm name (not id!)

Other Parameters

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

Name	Type	Description	Notes

body | string | [string] |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PostRequiredActionLowerPriority

PostRequiredActionLowerPriority(ctx, realm, alias).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	alias := "alias_example" // string | Alias of required action

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostRequiredActionLowerPriority(context.Background(), realm, alias).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostRequiredActionLowerPriority``: %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.
realm	string	realm name (not id!)
alias	string	Alias of required action

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

PostRequiredActionRaisePriority

PostRequiredActionRaisePriority(ctx, realm, alias).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	alias := "alias_example" // string | Alias of required action

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PostRequiredActionRaisePriority(context.Background(), realm, alias).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PostRequiredActionRaisePriority``: %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.
realm	string	realm name (not id!)
alias	string	Alias of required action

Other Parameters

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

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

PutAuthenticationConfig

PutAuthenticationConfig(ctx, realm, id).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | Configuration id
	authenticatorConfigRepresentation := *openapiclient.NewAuthenticatorConfigRepresentation() // AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PutAuthenticationConfig(context.Background(), realm, id).AuthenticatorConfigRepresentation(authenticatorConfigRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PutAuthenticationConfig``: %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.
realm	string	realm name (not id!)
id	string	Configuration id

Other Parameters

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

Name	Type	Description	Notes

authenticatorConfigRepresentation | AuthenticatorConfigRepresentation | AuthenticatorConfigRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PutExecutions

PutExecutions(ctx, realm, flowAlias).AuthenticationExecutionInfoRepresentation(authenticationExecutionInfoRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	flowAlias := "flowAlias_example" // string | Flow alias
	authenticationExecutionInfoRepresentation := *openapiclient.NewAuthenticationExecutionInfoRepresentation() // AuthenticationExecutionInfoRepresentation | AuthenticationExecutionInfoRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PutExecutions(context.Background(), realm, flowAlias).AuthenticationExecutionInfoRepresentation(authenticationExecutionInfoRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PutExecutions``: %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.
realm	string	realm name (not id!)
flowAlias	string	Flow alias

Other Parameters

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

Name	Type	Description	Notes

authenticationExecutionInfoRepresentation | AuthenticationExecutionInfoRepresentation | AuthenticationExecutionInfoRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PutFlow

PutFlow(ctx, realm, id).AuthenticationFlowRepresentation(authenticationFlowRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	id := "id_example" // string | 
	authenticationFlowRepresentation := *openapiclient.NewAuthenticationFlowRepresentation() // AuthenticationFlowRepresentation | AuthenticationFlowRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PutFlow(context.Background(), realm, id).AuthenticationFlowRepresentation(authenticationFlowRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PutFlow``: %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.
realm	string	realm name (not id!)
id	string

Other Parameters

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

Name	Type	Description	Notes

authenticationFlowRepresentation | AuthenticationFlowRepresentation | AuthenticationFlowRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

PutRequiredAction

PutRequiredAction(ctx, realm, alias).RequiredActionProviderRepresentation(requiredActionProviderRepresentation).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/GIT_USER_ID/GIT_REPO_ID"
)

func main() {
	realm := "realm_example" // string | realm name (not id!)
	alias := "alias_example" // string | Alias of required action
	requiredActionProviderRepresentation := *openapiclient.NewRequiredActionProviderRepresentation() // RequiredActionProviderRepresentation | RequiredActionProviderRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.AuthenticationManagementAPI.PutRequiredAction(context.Background(), realm, alias).RequiredActionProviderRepresentation(requiredActionProviderRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AuthenticationManagementAPI.PutRequiredAction``: %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.
realm	string	realm name (not id!)
alias	string	Alias of required action

Other Parameters

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

Name	Type	Description	Notes

requiredActionProviderRepresentation | RequiredActionProviderRepresentation | RequiredActionProviderRepresentation |

Return type

(empty response body)

Authorization

access_token

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

FilesExpand file tree

AuthenticationManagementAPI.md

Latest commit

History

AuthenticationManagementAPI.md

File metadata and controls

\AuthenticationManagementAPI

DeleteConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteExecution

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteFlow

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

DeleteRequiredAction

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAuthenticationConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetAuthenticatorProviders

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetClientAuthenticatorProviders

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetConfigDescription

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetExecution

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetExecutionConfig

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetExecutions

Example

Path Parameters