Skip to content

UsersAPI.md

Latest commit

 

History

History
2497 lines (1580 loc) · 67.2 KB

UsersAPI.md

File metadata and controls

2497 lines (1580 loc) · 67.2 KB

\UsersAPI

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

Method HTTP request Description
DeleteConsent Delete /{realm}/users/{id}/consents/{client}
DeleteCredential Delete /{realm}/users/{id}/credentials/{credentialId}
DeleteFederatedIdentity Delete /{realm}/users/{id}/federated-identity/{provider}
DeleteUserByRealmById Delete /{realm}/users/{id}
DeleteUserGroup Delete /{realm}/users/{id}/groups/{groupId}
GetConfiguredUserStorageCredentialTypes Get /{realm}/users/{id}/configured-user-storage-credential-types
GetConsents Get /{realm}/users/{id}/consents
GetCredentials Get /{realm}/users/{id}/credentials
GetFederatedIdentity Get /{realm}/users/{id}/federated-identity
GetMetadata Get /{realm}/users/profile/metadata
GetOfflineSession Get /{realm}/users/{id}/offline-sessions/{clientUuid}
GetProfile Get /{realm}/users/profile
GetSessions Get /{realm}/users/{id}/sessions
GetUserByRealmById Get /{realm}/users/{id}
GetUserGroups Get /{realm}/users/{id}/groups
GetUserGroupsCount Get /{realm}/users/{id}/groups/count
GetUsersByRealm Get /{realm}/users
GetUsersCount Get /{realm}/users/count
PostFederatedIdentity Post /{realm}/users/{id}/federated-identity/{provider}
PostImpersonation Post /{realm}/users/{id}/impersonation
PostLogout Post /{realm}/users/{id}/logout
PostMoveAfter Post /{realm}/users/{id}/credentials/{credentialId}/moveAfter/{newPreviousCredentialId}
PostMoveToFirst Post /{realm}/users/{id}/credentials/{credentialId}/moveToFirst
PostUsers Post /{realm}/users
PutDisableCredentialTypes Put /{realm}/users/{id}/disable-credential-types
PutExecuteActionsEmail Put /{realm}/users/{id}/execute-actions-email
PutProfile Put /{realm}/users/profile
PutResetPassword Put /{realm}/users/{id}/reset-password
PutResetPasswordEmail Put /{realm}/users/{id}/reset-password-email
PutSendVerifyEmail Put /{realm}/users/{id}/send-verify-email
PutUser Put /{realm}/users/{id}
PutUserGroup Put /{realm}/users/{id}/groups/{groupId}
PutUserLabel Put /{realm}/users/{id}/credentials/{credentialId}/userLabel

DeleteConsent

DeleteConsent(ctx, realm, id, client).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 | 
	client := "client_example" // string | Client id

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

Other Parameters

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

DeleteCredential

DeleteCredential(ctx, realm, id, credentialId).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 | 
	credentialId := "credentialId_example" // string | 

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

Other Parameters

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

DeleteFederatedIdentity

DeleteFederatedIdentity(ctx, realm, id, provider).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 | 
	provider := "provider_example" // string | Social login provider id

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

Other Parameters

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

DeleteUserByRealmById

DeleteUserByRealmById(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.UsersAPI.DeleteUserByRealmById(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.DeleteUserByRealmById``: %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!)
id string

Other Parameters

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

DeleteUserGroup

DeleteUserGroup(ctx, realm, id, groupId).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 | 
	groupId := "groupId_example" // string | 

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

Other Parameters

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

GetConfiguredUserStorageCredentialTypes

[]string GetConfiguredUserStorageCredentialTypes(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.UsersAPI.GetConfiguredUserStorageCredentialTypes(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetConfiguredUserStorageCredentialTypes``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetConfiguredUserStorageCredentialTypes`: []string
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetConfiguredUserStorageCredentialTypes`: %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!)
id string

Other Parameters

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

GetConsents

[]map[string]interface{} GetConsents(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.UsersAPI.GetConsents(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetConsents``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetConsents`: []map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetConsents`: %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!)
id string

Other Parameters

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

GetCredentials

[]CredentialRepresentation GetCredentials(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.UsersAPI.GetCredentials(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetCredentials``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetCredentials`: []CredentialRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetCredentials`: %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!)
id string

Other Parameters

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

Name Type Description Notes

Return type

[]CredentialRepresentation

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]

GetFederatedIdentity

[]FederatedIdentityRepresentation GetFederatedIdentity(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.UsersAPI.GetFederatedIdentity(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetFederatedIdentity``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetFederatedIdentity`: []FederatedIdentityRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetFederatedIdentity`: %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!)
id string

Other Parameters

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

Name Type Description Notes

Return type

[]FederatedIdentityRepresentation

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]

GetMetadata

UserProfileMetadata GetMetadata(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.UsersAPI.GetMetadata(context.Background(), realm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetMetadata``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetMetadata`: UserProfileMetadata
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetMetadata`: %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 apiGetMetadataRequest struct via the builder pattern

Name Type Description Notes

Return type

UserProfileMetadata

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]

GetOfflineSession

[]UserSessionRepresentation GetOfflineSession(ctx, realm, id, clientUuid).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 | 
	clientUuid := "clientUuid_example" // string | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetOfflineSession(context.Background(), realm, id, clientUuid).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetOfflineSession``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetOfflineSession`: []UserSessionRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetOfflineSession`: %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!)
id string
clientUuid string

Other Parameters

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

Name Type Description Notes

Return type

[]UserSessionRepresentation

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]

GetProfile

UPConfig GetProfile(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.UsersAPI.GetProfile(context.Background(), realm).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetProfile``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetProfile`: UPConfig
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetProfile`: %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 apiGetProfileRequest struct via the builder pattern

Name Type Description Notes

Return type

UPConfig

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]

GetSessions

[]UserSessionRepresentation GetSessions(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.UsersAPI.GetSessions(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetSessions``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSessions`: []UserSessionRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetSessions`: %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!)
id string

Other Parameters

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

Name Type Description Notes

Return type

[]UserSessionRepresentation

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]

GetUserByRealmById

UserRepresentation GetUserByRealmById(ctx, realm, id).UserProfileMetadata(userProfileMetadata).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 | 
	userProfileMetadata := "userProfileMetadata_example" // string | Indicates if the user profile metadata should be added to the response (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUserByRealmById(context.Background(), realm, id).UserProfileMetadata(userProfileMetadata).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUserByRealmById``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserByRealmById`: UserRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUserByRealmById`: %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!)
id string

Other Parameters

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

Name Type Description Notes

userProfileMetadata | string | Indicates if the user profile metadata should be added to the response |

Return type

UserRepresentation

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]

GetUserGroups

[]GroupRepresentation GetUserGroups(ctx, realm, id).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).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 | 
	briefRepresentation := "briefRepresentation_example" // string |  (optional)
	first := "first_example" // string |  (optional)
	max := "max_example" // string |  (optional)
	search := "search_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUserGroups(context.Background(), realm, id).BriefRepresentation(briefRepresentation).First(first).Max(max).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUserGroups``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserGroups`: []GroupRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUserGroups`: %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!)
id string

Other Parameters

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

Name Type Description Notes

briefRepresentation | string | | first | string | | max | string | | search | string | |

Return type

[]GroupRepresentation

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]

GetUserGroupsCount

map[string]int64 GetUserGroupsCount(ctx, realm, id).Search(search).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 | 
	search := "search_example" // string |  (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUserGroupsCount(context.Background(), realm, id).Search(search).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUserGroupsCount``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUserGroupsCount`: map[string]int64
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUserGroupsCount`: %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!)
id string

Other Parameters

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

Name Type Description Notes

search | string | |

Return type

map[string]int64

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]

GetUsersByRealm

[]UserRepresentation GetUsersByRealm(ctx, realm).BriefRepresentation(briefRepresentation).Email(email).EmailVerified(emailVerified).Enabled(enabled).Exact(exact).First(first).FirstName(firstName).IdpAlias(idpAlias).IdpUserId(idpUserId).LastName(lastName).Max(max).Q(q).Search(search).Username(username).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!)
	briefRepresentation := "briefRepresentation_example" // string | Boolean which defines whether brief representations are returned (default: false) (optional)
	email := "email_example" // string | A String contained in email, or the complete email, if param "exact" is true (optional)
	emailVerified := "emailVerified_example" // string | whether the email has been verified (optional)
	enabled := "enabled_example" // string | Boolean representing if user is enabled or not (optional)
	exact := "exact_example" // string | Boolean which defines whether the params "last", "first", "email" and "username" must match exactly (optional)
	first := "first_example" // string | Pagination offset (optional)
	firstName := "firstName_example" // string | A String contained in firstName, or the complete firstName, if param "exact" is true (optional)
	idpAlias := "idpAlias_example" // string | The alias of an Identity Provider linked to the user (optional)
	idpUserId := "idpUserId_example" // string | The userId at an Identity Provider linked to the user (optional)
	lastName := "lastName_example" // string | A String contained in lastName, or the complete lastName, if param "exact" is true (optional)
	max := "max_example" // string | Maximum results size (defaults to 100) (optional)
	q := "q_example" // string | A query to search for custom attributes, in the format 'key1:value2 key2:value2' (optional)
	search := "search_example" // string | A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search. (optional)
	username := "username_example" // string | A String contained in username, or the complete username, if param "exact" is true (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUsersByRealm(context.Background(), realm).BriefRepresentation(briefRepresentation).Email(email).EmailVerified(emailVerified).Enabled(enabled).Exact(exact).First(first).FirstName(firstName).IdpAlias(idpAlias).IdpUserId(idpUserId).LastName(lastName).Max(max).Q(q).Search(search).Username(username).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUsersByRealm``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUsersByRealm`: []UserRepresentation
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUsersByRealm`: %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 apiGetUsersByRealmRequest struct via the builder pattern

Name Type Description Notes

briefRepresentation | string | Boolean which defines whether brief representations are returned (default: false) | email | string | A String contained in email, or the complete email, if param "exact" is true | emailVerified | string | whether the email has been verified | enabled | string | Boolean representing if user is enabled or not | exact | string | Boolean which defines whether the params "last", "first", "email" and "username" must match exactly | first | string | Pagination offset | firstName | string | A String contained in firstName, or the complete firstName, if param "exact" is true | idpAlias | string | The alias of an Identity Provider linked to the user | idpUserId | string | The userId at an Identity Provider linked to the user | lastName | string | A String contained in lastName, or the complete lastName, if param "exact" is true | max | string | Maximum results size (defaults to 100) | q | string | A query to search for custom attributes, in the format 'key1:value2 key2:value2' | search | string | A String contained in username, first or last name, or email. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search. | username | string | A String contained in username, or the complete username, if param "exact" is true |

Return type

[]UserRepresentation

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]

GetUsersCount

int32 GetUsersCount(ctx, realm).Email(email).EmailVerified(emailVerified).Enabled(enabled).FirstName(firstName).LastName(lastName).Q(q).Search(search).Username(username).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!)
	email := "email_example" // string | email filter (optional)
	emailVerified := "emailVerified_example" // string |  (optional)
	enabled := "enabled_example" // string | Boolean representing if user is enabled or not (optional)
	firstName := "firstName_example" // string | first name filter (optional)
	lastName := "lastName_example" // string | last name filter (optional)
	q := "q_example" // string |  (optional)
	search := "search_example" // string | arbitrary search string for all the fields below. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search. (optional)
	username := "username_example" // string | username filter (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.UsersAPI.GetUsersCount(context.Background(), realm).Email(email).EmailVerified(emailVerified).Enabled(enabled).FirstName(firstName).LastName(lastName).Q(q).Search(search).Username(username).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.GetUsersCount``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetUsersCount`: int32
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.GetUsersCount`: %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 apiGetUsersCountRequest struct via the builder pattern

Name Type Description Notes

email | string | email filter | emailVerified | string | | enabled | string | Boolean representing if user is enabled or not | firstName | string | first name filter | lastName | string | last name filter | q | string | | search | string | arbitrary search string for all the fields below. Default search behavior is prefix-based (e.g., foo or foo*). Use foo for infix search and "foo" for exact search. | username | string | username filter |

Return type

int32

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]

PostFederatedIdentity

PostFederatedIdentity(ctx, realm, id, provider).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 | 
	provider := "provider_example" // string | Social login provider id

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

Other Parameters

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

PostImpersonation

map[string]map[string]interface{} PostImpersonation(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.UsersAPI.PostImpersonation(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PostImpersonation``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `PostImpersonation`: map[string]map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `UsersAPI.PostImpersonation`: %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!)
id string

Other Parameters

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

Name Type Description Notes

Return type

map[string]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]

PostLogout

PostLogout(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.UsersAPI.PostLogout(context.Background(), realm, id).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PostLogout``: %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!)
id string

Other Parameters

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

PostMoveAfter

PostMoveAfter(ctx, realm, id, credentialId, newPreviousCredentialId).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 | 
	credentialId := "credentialId_example" // string | The credential to move
	newPreviousCredentialId := "newPreviousCredentialId_example" // string | The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.PostMoveAfter(context.Background(), realm, id, credentialId, newPreviousCredentialId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PostMoveAfter``: %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!)
id string
credentialId string The credential to move
newPreviousCredentialId string The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.

Other Parameters

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

PostMoveToFirst

PostMoveToFirst(ctx, realm, id, credentialId).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 | 
	credentialId := "credentialId_example" // string | The credential to move

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.PostMoveToFirst(context.Background(), realm, id, credentialId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PostMoveToFirst``: %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!)
id string
credentialId string The credential to move

Other Parameters

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

PostUsers

PostUsers(ctx, realm).UserRepresentation(userRepresentation).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!)
	userRepresentation := *openapiclient.NewUserRepresentation() // UserRepresentation | UserRepresentation (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.PostUsers(context.Background(), realm).UserRepresentation(userRepresentation).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PostUsers``: %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 apiPostUsersRequest struct via the builder pattern

Name Type Description Notes

userRepresentation | UserRepresentation | UserRepresentation |

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]

PutDisableCredentialTypes

PutDisableCredentialTypes(ctx, realm, id).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!)
	id := "id_example" // string | 
	body := "body_example" // string | [string] (optional)

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

Other Parameters

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

PutExecuteActionsEmail

PutExecuteActionsEmail(ctx, realm, id).ClientId(clientId).Lifespan(lifespan).RedirectUri(redirectUri).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!)
	id := "id_example" // string | 
	clientId := "clientId_example" // string | Client id (optional)
	lifespan := "lifespan_example" // string | Number of seconds after which the generated token expires (optional)
	redirectUri := "redirectUri_example" // string | Redirect uri (optional)
	body := "body_example" // string | [string] (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.UsersAPI.PutExecuteActionsEmail(context.Background(), realm, id).ClientId(clientId).Lifespan(lifespan).RedirectUri(redirectUri).Body(body).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `UsersAPI.PutExecuteActionsEmail``: %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!)
id string

Other Parameters

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

Name Type Description Notes

clientId | string | Client id | lifespan | string | Number of seconds after which the generated token expires | redirectUri | string | Redirect uri | 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]

PutProfile

UPConfig PutProfile(ctx, realm).UPConfig(uPConfig).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!)
	uPConfig := *openapiclient.NewUPConfig() // UPConfig | UPConfig (optional)

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

Name Type Description Notes

uPConfig | UPConfig | UPConfig |

Return type

UPConfig

Authorization

access_token

HTTP request headers

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

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

PutResetPassword

PutResetPassword(ctx, realm, id).CredentialRepresentation(credentialRepresentation).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 | 
	credentialRepresentation := *openapiclient.NewCredentialRepresentation() // CredentialRepresentation | CredentialRepresentation (optional)

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

Other Parameters

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

Name Type Description Notes

credentialRepresentation | CredentialRepresentation | CredentialRepresentation |

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]

PutResetPasswordEmail

PutResetPasswordEmail(ctx, realm, id).ClientId(clientId).RedirectUri(redirectUri).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 | 
	clientId := "clientId_example" // string | client id (optional)
	redirectUri := "redirectUri_example" // string | redirect uri (optional)

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

Other Parameters

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

Name Type Description Notes

clientId | string | client id | redirectUri | string | redirect uri |

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]

PutSendVerifyEmail

PutSendVerifyEmail(ctx, realm, id).ClientId(clientId).RedirectUri(redirectUri).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 | 
	clientId := "clientId_example" // string | Client id (optional)
	redirectUri := "redirectUri_example" // string | Redirect uri (optional)

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

Other Parameters

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

Name Type Description Notes

clientId | string | Client id | redirectUri | string | Redirect uri |

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]

PutUser

PutUser(ctx, realm, id).UserRepresentation(userRepresentation).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 | 
	userRepresentation := *openapiclient.NewUserRepresentation() // UserRepresentation | UserRepresentation (optional)

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

Other Parameters

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

Name Type Description Notes

userRepresentation | UserRepresentation | UserRepresentation |

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]

PutUserGroup

PutUserGroup(ctx, realm, id, groupId).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 | 
	groupId := "groupId_example" // string | 

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

Other Parameters

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

PutUserLabel

PutUserLabel(ctx, realm, id, credentialId).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!)
	id := "id_example" // string | 
	credentialId := "credentialId_example" // string | 
	body := "body_example" // string | [string] (optional)

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

Other Parameters

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