This is a REST API reference for the Keycloak Admin REST API.

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

• API version: 1.0
• Package version: 24.0.2
• Generator version: 7.6.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import keycloakadminclient "github.com/miguoliang/keycloakadminclient"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

For using other server than the one defined on index 0 set context value keycloakadminclient.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), keycloakadminclient.ContextServerIndex, 1)

Templated server URL is formatted using default variables from configuration or from context value keycloakadminclient.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), keycloakadminclient.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using keycloakadminclient.ContextOperationServerIndices and keycloakadminclient.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), keycloakadminclient.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), keycloakadminclient.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

All URIs are relative to http://localhost

• AbstractPolicyRepresentation
• Access
• AccessToken
• AddressClaimSet
• AdminEventRepresentation
• AuthDetailsRepresentation
• AuthenticationExecutionExportRepresentation
• AuthenticationExecutionInfoRepresentation
• AuthenticationExecutionRepresentation
• AuthenticationFlowRepresentation
• AuthenticatorConfigInfoRepresentation
• AuthenticatorConfigRepresentation
• Authorization
• CertificateRepresentation
• ClaimRepresentation
• ClientInitialAccessCreatePresentation
• ClientInitialAccessPresentation
• ClientMappingsRepresentation
• ClientPoliciesRepresentation
• ClientPolicyConditionRepresentation
• ClientPolicyExecutorRepresentation
• ClientPolicyRepresentation
• ClientProfileRepresentation
• ClientProfilesRepresentation
• ClientRepresentation
• ClientScopeRepresentation
• ComponentExportRepresentation
• ComponentRepresentation
• ComponentTypeRepresentation
• Composites
• ConfigPropertyRepresentation
• Confirmation
• CredentialRepresentation
• DecisionEffect
• DecisionStrategy
• EnforcementMode
• EvaluationResultRepresentation
• EventRepresentation
• FederatedIdentityRepresentation
• GlobalRequestResult
• GroupRepresentation
• IDToken
• IdentityProviderMapperRepresentation
• IdentityProviderMapperTypeRepresentation
• IdentityProviderRepresentation
• InstallationAdapterConfig
• KeyMetadataRepresentation
• KeyStoreConfig
• KeyUse
• KeysMetadataRepresentation
• Logic
• ManagementPermissionReference
• MappingsRepresentation
• MethodConfig
• PathCacheConfig
• PathConfig
• PathSegment
• Permission
• PolicyEnforcementMode
• PolicyEnforcerConfig
• PolicyEvaluationRequest
• PolicyEvaluationResponse
• PolicyProviderRepresentation
• PolicyRepresentation
• PolicyResultRepresentation
• ProtocolMapperEvaluationRepresentation
• ProtocolMapperRepresentation
• PublishedRealmRepresentation
• RealmEventsConfigRepresentation
• RealmRepresentation
• RequiredActionProviderRepresentation
• ResourceOwnerRepresentation
• ResourceRepresentation
• ResourceRepresentationOwner
• ResourceServerRepresentation
• RoleRepresentation
• RolesRepresentation
• ScopeEnforcementMode
• ScopeMappingRepresentation
• ScopeRepresentation
• SocialLinkRepresentation
• UPAttribute
• UPAttributePermissions
• UPAttributeRequired
• UPAttributeSelector
• UPConfig
• UPGroup
• UnmanagedAttributePolicy
• UserConsentRepresentation
• UserFederationMapperRepresentation
• UserFederationProviderRepresentation
• UserProfileAttributeGroupMetadata
• UserProfileAttributeMetadata
• UserProfileMetadata
• UserRepresentation
• UserSessionRepresentation

Endpoints do not require authorization.

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime