Go API client for logto

API references for Logto services.

Note: The documentation is for Logto Cloud. If you are using Logto OSS, please refer to the response of /api/swagger.json endpoint on your Logto instance.

Overview

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: Cloud
• Package version: 1.0.0
• Generator version: 7.7.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

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 logto "github.com/mostafa/go-api-client"

To use a proxy, set the environment variable HTTP_PROXY:

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

Configuration of Server URL

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

Select Server Configuration

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

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

Templated Server URL

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

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

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

URLs Configuration per Operation

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 logto.ContextOperationServerIndices and logto.ContextOperationServerVariables context maps.

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

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ApplicationsAPI	AssignApplicationRoles	Post /api/applications/{applicationId}/roles	Assign API resource roles to application
ApplicationsAPI	CreateApplication	Post /api/applications	Create an application
ApplicationsAPI	CreateApplicationProtectedAppMetadataCustomDomain	Post /api/applications/{id}/protected-app-metadata/custom-domains	Add a custom domain to the protected application.
ApplicationsAPI	CreateApplicationUserConsentOrganization	Post /api/applications/{id}/users/{userId}/consent-organizations	Grant a list of organization access of a user for a application.
ApplicationsAPI	CreateApplicationUserConsentScope	Post /api/applications/{applicationId}/user-consent-scopes	Assign user consent scopes to application.
ApplicationsAPI	DeleteApplication	Delete /api/applications/{id}	Delete application
ApplicationsAPI	DeleteApplicationProtectedAppMetadataCustomDomain	Delete /api/applications/{id}/protected-app-metadata/custom-domains/{domain}	Delete a custom domain.
ApplicationsAPI	DeleteApplicationRole	Delete /api/applications/{applicationId}/roles/{roleId}	Remove a API resource role from application
ApplicationsAPI	DeleteApplicationUserConsentOrganization	Delete /api/applications/{id}/users/{userId}/consent-organizations/{organizationId}	Revoke a user's access to an organization for a application.
ApplicationsAPI	DeleteApplicationUserConsentScope	Delete /api/applications/{applicationId}/user-consent-scopes/{scopeType}/{scopeId}	Remove user consent scope from application.
ApplicationsAPI	GetApplication	Get /api/applications/{id}	Get application
ApplicationsAPI	GetApplicationSignInExperience	Get /api/applications/{applicationId}/sign-in-experience	Get the application level sign-in experience
ApplicationsAPI	ListApplicationOrganizations	Get /api/applications/{id}/organizations	Get application organizations
ApplicationsAPI	ListApplicationProtectedAppMetadataCustomDomains	Get /api/applications/{id}/protected-app-metadata/custom-domains	Get the list of custom domains of the protected application.
ApplicationsAPI	ListApplicationRoles	Get /api/applications/{applicationId}/roles	Get application API resource roles
ApplicationsAPI	ListApplicationUserConsentOrganizations	Get /api/applications/{id}/users/{userId}/consent-organizations	List all the user consented organizations of a application.
ApplicationsAPI	ListApplicationUserConsentScopes	Get /api/applications/{applicationId}/user-consent-scopes	List all the user consent scopes of an application.
ApplicationsAPI	ListApplications	Get /api/applications	Get applications
ApplicationsAPI	ReplaceApplicationRoles	Put /api/applications/{applicationId}/roles	Update API resource roles for application
ApplicationsAPI	ReplaceApplicationSignInExperience	Put /api/applications/{applicationId}/sign-in-experience	Update application level sign-in experience
ApplicationsAPI	ReplaceApplicationUserConsentOrganizations	Put /api/applications/{id}/users/{userId}/consent-organizations	Grant a list of organization access of a user for a application.
ApplicationsAPI	UpdateApplication	Patch /api/applications/{id}	Update application
AuditLogsAPI	GetLog	Get /api/logs/{id}	Get log
AuditLogsAPI	ListLogs	Get /api/logs	Get logs
AuthnAPI	AssertSaml	Post /api/authn/saml/{connectorId}	SAML ACS endpoint (social)
AuthnAPI	AssertSingleSignOnSaml	Post /api/authn/single-sign-on/saml/{connectorId}	SAML ACS endpoint (SSO)
AuthnAPI	GetHasuraAuth	Get /api/authn/hasura	Hasura auth hook endpoint
ConfigsAPI	DeleteJwtCustomizer	Delete /api/configs/jwt-customizer/{tokenTypePath}	Delete JWT customizer
ConfigsAPI	DeleteOidcKey	Delete /api/configs/oidc/{keyType}/{keyId}	Delete OIDC key
ConfigsAPI	GetAdminConsoleConfig	Get /api/configs/admin-console	Get admin console config
ConfigsAPI	GetJwtCustomizer	Get /api/configs/jwt-customizer/{tokenTypePath}	Get JWT customizer
ConfigsAPI	GetOidcKeys	Get /api/configs/oidc/{keyType}	Get OIDC keys
ConfigsAPI	ListJwtCustomizers	Get /api/configs/jwt-customizer	Get all JWT customizers
ConfigsAPI	RotateOidcKeys	Post /api/configs/oidc/{keyType}/rotate	Rotate OIDC keys
ConfigsAPI	TestJwtCustomizer	Post /api/configs/jwt-customizer/test	Test JWT customizer
ConfigsAPI	UpdateAdminConsoleConfig	Patch /api/configs/admin-console	Update admin console config
ConfigsAPI	UpdateJwtCustomizer	Patch /api/configs/jwt-customizer/{tokenTypePath}	Update JWT customizer
ConfigsAPI	UpsertJwtCustomizer	Put /api/configs/jwt-customizer/{tokenTypePath}	Create or update JWT customizer
ConnectorFactoriesAPI	GetConnectorFactory	Get /api/connector-factories/{id}	Get connector factory
ConnectorFactoriesAPI	ListConnectorFactories	Get /api/connector-factories	Get connector factories
ConnectorsAPI	CreateConnector	Post /api/connectors	Create connector
ConnectorsAPI	CreateConnectorAuthorizationUri	Post /api/connectors/{connectorId}/authorization-uri	Get connector's authorization URI
ConnectorsAPI	CreateConnectorTest	Post /api/connectors/{factoryId}/test	Test passwordless connector
ConnectorsAPI	DeleteConnector	Delete /api/connectors/{id}	Delete connector
ConnectorsAPI	GetConnector	Get /api/connectors/{id}	Get connector
ConnectorsAPI	ListConnectors	Get /api/connectors	Get connectors
ConnectorsAPI	UpdateConnector	Patch /api/connectors/{id}	Update connector
CustomPhrasesAPI	DeleteCustomPhrase	Delete /api/custom-phrases/{languageTag}	Delete custom phrase
CustomPhrasesAPI	GetCustomPhrase	Get /api/custom-phrases/{languageTag}	Get custom phrases
CustomPhrasesAPI	ListCustomPhrases	Get /api/custom-phrases	Get all custom phrases
CustomPhrasesAPI	ReplaceCustomPhrase	Put /api/custom-phrases/{languageTag}	Upsert custom phrases
DashboardAPI	GetActiveUserCounts	Get /api/dashboard/users/active	Get active user data
DashboardAPI	GetNewUserCounts	Get /api/dashboard/users/new	Get new user count
DashboardAPI	GetTotalUserCount	Get /api/dashboard/users/total	Get total user count
DomainsAPI	CreateDomain	Post /api/domains	Create domain
DomainsAPI	DeleteDomain	Delete /api/domains/{id}	Delete domain
DomainsAPI	GetDomain	Get /api/domains/{id}	Get domain
DomainsAPI	ListDomains	Get /api/domains	Get domains
HooksAPI	CreateHook	Post /api/hooks	Create a hook
HooksAPI	CreateHookTest	Post /api/hooks/{id}/test	Test hook
HooksAPI	DeleteHook	Delete /api/hooks/{id}	Delete hook
HooksAPI	GetHook	Get /api/hooks/{id}	Get hook
HooksAPI	ListHookRecentLogs	Get /api/hooks/{id}/recent-logs	Get recent logs for a hook
HooksAPI	ListHooks	Get /api/hooks	Get hooks
HooksAPI	UpdateHook	Patch /api/hooks/{id}	Update hook
HooksAPI	UpdateHookSigningKey	Patch /api/hooks/{id}/signing-key	Update signing key for a hook
InteractionAPI	ApiInteractionBindMfaPost	Post /api/interaction/bind-mfa
InteractionAPI	ApiInteractionConsentGet	Get /api/interaction/consent
InteractionAPI	ApiInteractionConsentPost	Post /api/interaction/consent
InteractionAPI	ApiInteractionDelete	Delete /api/interaction
InteractionAPI	ApiInteractionEventPut	Put /api/interaction/event
InteractionAPI	ApiInteractionIdentifiersPatch	Patch /api/interaction/identifiers
InteractionAPI	ApiInteractionMfaPut	Put /api/interaction/mfa
InteractionAPI	ApiInteractionMfaSkippedPut	Put /api/interaction/mfa-skipped
InteractionAPI	ApiInteractionProfileDelete	Delete /api/interaction/profile
InteractionAPI	ApiInteractionProfilePatch	Patch /api/interaction/profile
InteractionAPI	ApiInteractionProfilePut	Put /api/interaction/profile
InteractionAPI	ApiInteractionPut	Put /api/interaction
InteractionAPI	ApiInteractionSingleSignOnConnectorIdAuthenticationPost	Post /api/interaction/single-sign-on/{connectorId}/authentication
InteractionAPI	ApiInteractionSingleSignOnConnectorIdAuthorizationUrlPost	Post /api/interaction/single-sign-on/{connectorId}/authorization-url
InteractionAPI	ApiInteractionSingleSignOnConnectorIdRegistrationPost	Post /api/interaction/single-sign-on/{connectorId}/registration
InteractionAPI	ApiInteractionSingleSignOnConnectorsGet	Get /api/interaction/single-sign-on/connectors
InteractionAPI	ApiInteractionSubmitPost	Post /api/interaction/submit
InteractionAPI	ApiInteractionVerificationSocialAuthorizationUriPost	Post /api/interaction/verification/social-authorization-uri
InteractionAPI	ApiInteractionVerificationTotpPost	Post /api/interaction/verification/totp
InteractionAPI	ApiInteractionVerificationVerificationCodePost	Post /api/interaction/verification/verification-code
InteractionAPI	ApiInteractionVerificationWebauthnAuthenticationPost	Post /api/interaction/verification/webauthn-authentication
InteractionAPI	ApiInteractionVerificationWebauthnRegistrationPost	Post /api/interaction/verification/webauthn-registration
OrganizationInvitationsAPI	CreateOrganizationInvitation	Post /api/organization-invitations	Create organization invitation
OrganizationInvitationsAPI	CreateOrganizationInvitationMessage	Post /api/organization-invitations/{id}/message	Resend invitation message
OrganizationInvitationsAPI	DeleteOrganizationInvitation	Delete /api/organization-invitations/{id}	Delete organization invitation
OrganizationInvitationsAPI	GetOrganizationInvitation	Get /api/organization-invitations/{id}	Get organization invitation
OrganizationInvitationsAPI	ListOrganizationInvitations	Get /api/organization-invitations	Get organization invitations
OrganizationInvitationsAPI	ReplaceOrganizationInvitationStatus	Put /api/organization-invitations/{id}/status	Update organization invitation status
OrganizationRolesAPI	CreateOrganizationRole	Post /api/organization-roles	Create an organization role
OrganizationRolesAPI	CreateOrganizationRoleResourceScope	Post /api/organization-roles/{id}/resource-scopes	Assign resource scopes to organization role
OrganizationRolesAPI	CreateOrganizationRoleScope	Post /api/organization-roles/{id}/scopes	Assign organization scopes to organization role
OrganizationRolesAPI	DeleteOrganizationRole	Delete /api/organization-roles/{id}	Delete organization role
OrganizationRolesAPI	DeleteOrganizationRoleResourceScope	Delete /api/organization-roles/{id}/resource-scopes/{scopeId}	Remove resource scope
OrganizationRolesAPI	DeleteOrganizationRoleScope	Delete /api/organization-roles/{id}/scopes/{organizationScopeId}	Remove organization scope
OrganizationRolesAPI	GetOrganizationRole	Get /api/organization-roles/{id}	Get organization role
OrganizationRolesAPI	ListOrganizationRoleResourceScopes	Get /api/organization-roles/{id}/resource-scopes	Get organization role resource scopes
OrganizationRolesAPI	ListOrganizationRoleScopes	Get /api/organization-roles/{id}/scopes	Get organization role scopes
OrganizationRolesAPI	ListOrganizationRoles	Get /api/organization-roles	Get organization roles
OrganizationRolesAPI	ReplaceOrganizationRoleResourceScopes	Put /api/organization-roles/{id}/resource-scopes	Replace resource scopes for organization role
OrganizationRolesAPI	ReplaceOrganizationRoleScopes	Put /api/organization-roles/{id}/scopes	Replace organization scopes for organization role
OrganizationRolesAPI	UpdateOrganizationRole	Patch /api/organization-roles/{id}	Update organization role
OrganizationScopesAPI	CreateOrganizationScope	Post /api/organization-scopes	Create an organization scope
OrganizationScopesAPI	DeleteOrganizationScope	Delete /api/organization-scopes/{id}	Delete organization scope
OrganizationScopesAPI	GetOrganizationScope	Get /api/organization-scopes/{id}	Get organization scope
OrganizationScopesAPI	ListOrganizationScopes	Get /api/organization-scopes	Get organization scopes
OrganizationScopesAPI	UpdateOrganizationScope	Patch /api/organization-scopes/{id}	Update organization scope
OrganizationsAPI	AddOrganizationApplications	Post /api/organizations/{id}/applications	Add organization application
OrganizationsAPI	AddOrganizationUsers	Post /api/organizations/{id}/users	Add user members to organization
OrganizationsAPI	AssignOrganizationRolesToApplication	Post /api/organizations/{id}/applications/{applicationId}/roles	Add organization application role
OrganizationsAPI	AssignOrganizationRolesToApplications	Post /api/organizations/{id}/applications/roles	Assign roles to applications in an organization
OrganizationsAPI	AssignOrganizationRolesToUser	Post /api/organizations/{id}/users/{userId}/roles	Assign roles to a user in an organization
OrganizationsAPI	AssignOrganizationRolesToUsers	Post /api/organizations/{id}/users/roles	Assign roles to organization user members
OrganizationsAPI	CreateOrganization	Post /api/organizations	Create an organization
OrganizationsAPI	CreateOrganizationJitEmailDomain	Post /api/organizations/{id}/jit/email-domains	Add organization JIT email domain
OrganizationsAPI	CreateOrganizationJitRole	Post /api/organizations/{id}/jit/roles	Add organization JIT default roles
OrganizationsAPI	CreateOrganizationJitSsoConnector	Post /api/organizations/{id}/jit/sso-connectors	Add organization JIT SSO connectors
OrganizationsAPI	DeleteOrganization	Delete /api/organizations/{id}	Delete organization
OrganizationsAPI	DeleteOrganizationApplication	Delete /api/organizations/{id}/applications/{applicationId}	Remove organization application
OrganizationsAPI	DeleteOrganizationApplicationRole	Delete /api/organizations/{id}/applications/{applicationId}/roles/{organizationRoleId}	Remove organization application role
OrganizationsAPI	DeleteOrganizationJitEmailDomain	Delete /api/organizations/{id}/jit/email-domains/{emailDomain}	Remove organization JIT email domain
OrganizationsAPI	DeleteOrganizationJitRole	Delete /api/organizations/{id}/jit/roles/{organizationRoleId}	Remove organization JIT default role
OrganizationsAPI	DeleteOrganizationJitSsoConnector	Delete /api/organizations/{id}/jit/sso-connectors/{ssoConnectorId}	Remove organization JIT SSO connector
OrganizationsAPI	DeleteOrganizationUser	Delete /api/organizations/{id}/users/{userId}	Remove user member from organization
OrganizationsAPI	DeleteOrganizationUserRole	Delete /api/organizations/{id}/users/{userId}/roles/{organizationRoleId}	Remove a role from a user in an organization
OrganizationsAPI	GetOrganization	Get /api/organizations/{id}	Get organization
OrganizationsAPI	ListOrganizationApplicationRoles	Get /api/organizations/{id}/applications/{applicationId}/roles	Get organization application roles
OrganizationsAPI	ListOrganizationApplications	Get /api/organizations/{id}/applications	Get organization applications
OrganizationsAPI	ListOrganizationJitEmailDomains	Get /api/organizations/{id}/jit/email-domains	Get organization JIT email domains
OrganizationsAPI	ListOrganizationJitRoles	Get /api/organizations/{id}/jit/roles	Get organization JIT default roles
OrganizationsAPI	ListOrganizationJitSsoConnectors	Get /api/organizations/{id}/jit/sso-connectors	Get organization JIT SSO connectors
OrganizationsAPI	ListOrganizationUserRoles	Get /api/organizations/{id}/users/{userId}/roles	Get roles for a user in an organization
OrganizationsAPI	ListOrganizationUserScopes	Get /api/organizations/{id}/users/{userId}/scopes	Get scopes for a user in an organization tailored by the organization roles
OrganizationsAPI	ListOrganizationUsers	Get /api/organizations/{id}/users	Get organization user members
OrganizationsAPI	ListOrganizations	Get /api/organizations	Get organizations
OrganizationsAPI	ReplaceOrganizationApplicationRoles	Put /api/organizations/{id}/applications/{applicationId}/roles	Replace organization application roles
OrganizationsAPI	ReplaceOrganizationApplications	Put /api/organizations/{id}/applications	Replace organization applications
OrganizationsAPI	ReplaceOrganizationJitEmailDomains	Put /api/organizations/{id}/jit/email-domains	Replace organization JIT email domains
OrganizationsAPI	ReplaceOrganizationJitRoles	Put /api/organizations/{id}/jit/roles	Replace organization JIT default roles
OrganizationsAPI	ReplaceOrganizationJitSsoConnectors	Put /api/organizations/{id}/jit/sso-connectors	Replace organization JIT SSO connectors
OrganizationsAPI	ReplaceOrganizationUserRoles	Put /api/organizations/{id}/users/{userId}/roles	Update roles for a user in an organization
OrganizationsAPI	ReplaceOrganizationUsers	Put /api/organizations/{id}/users	Replace organization user members
OrganizationsAPI	UpdateOrganization	Patch /api/organizations/{id}	Update organization
ResourcesAPI	CreateResource	Post /api/resources	Create an API resource
ResourcesAPI	CreateResourceScope	Post /api/resources/{resourceId}/scopes	Create API resource scope
ResourcesAPI	DeleteResource	Delete /api/resources/{id}	Delete API resource
ResourcesAPI	DeleteResourceScope	Delete /api/resources/{resourceId}/scopes/{scopeId}	Delete API resource scope
ResourcesAPI	GetResource	Get /api/resources/{id}	Get API resource
ResourcesAPI	ListResourceScopes	Get /api/resources/{resourceId}/scopes	Get API resource scopes
ResourcesAPI	ListResources	Get /api/resources	Get API resources
ResourcesAPI	UpdateResource	Patch /api/resources/{id}	Update API resource
ResourcesAPI	UpdateResourceIsDefault	Patch /api/resources/{id}/is-default	Set API resource as default
ResourcesAPI	UpdateResourceScope	Patch /api/resources/{resourceId}/scopes/{scopeId}	Update API resource scope
RolesAPI	CreateRole	Post /api/roles	Create a role
RolesAPI	CreateRoleApplication	Post /api/roles/{id}/applications	Assign role to applications
RolesAPI	CreateRoleScope	Post /api/roles/{id}/scopes	Link scopes to role
RolesAPI	CreateRoleUser	Post /api/roles/{id}/users	Assign role to users
RolesAPI	DeleteRole	Delete /api/roles/{id}	Delete role
RolesAPI	DeleteRoleApplication	Delete /api/roles/{id}/applications/{applicationId}	Remove role from application
RolesAPI	DeleteRoleScope	Delete /api/roles/{id}/scopes/{scopeId}	Unlink scope from role
RolesAPI	DeleteRoleUser	Delete /api/roles/{id}/users/{userId}	Remove role from user
RolesAPI	GetRole	Get /api/roles/{id}	Get role
RolesAPI	ListRoleApplications	Get /api/roles/{id}/applications	Get role applications
RolesAPI	ListRoleScopes	Get /api/roles/{id}/scopes	Get role scopes
RolesAPI	ListRoleUsers	Get /api/roles/{id}/users	Get role users
RolesAPI	ListRoles	Get /api/roles	Get roles
RolesAPI	UpdateRole	Patch /api/roles/{id}	Update role
SSOConnectorProvidersAPI	ListSsoConnectorProviders	Get /api/sso-connector-providers	List all the supported SSO connector provider details
SSOConnectorsAPI	CreateSsoConnector	Post /api/sso-connectors	Create SSO connector
SSOConnectorsAPI	DeleteSsoConnector	Delete /api/sso-connectors/{id}	Delete SSO connector
SSOConnectorsAPI	GetSsoConnector	Get /api/sso-connectors/{id}	Get SSO connector
SSOConnectorsAPI	ListSsoConnectors	Get /api/sso-connectors	List SSO connectors
SSOConnectorsAPI	UpdateSsoConnector	Patch /api/sso-connectors/{id}	Update SSO connector
SignInExperienceAPI	GetSignInExp	Get /api/sign-in-exp	Get default sign-in experience settings
SignInExperienceAPI	UpdateSignInExp	Patch /api/sign-in-exp	Update default sign-in experience settings
StatusAPI	GetStatus	Get /api/status	Health check
SwaggerJsonAPI	GetSwaggerJson	Get /api/swagger.json	Get Swagger JSON
SystemsAPI	GetSystemApplicationConfig	Get /api/systems/application	Get the application constants.
UserAssetsAPI	CreateUserAsset	Post /api/user-assets	Upload asset
UserAssetsAPI	GetUserAssetServiceStatus	Get /api/user-assets/service-status	Get service status
UsersAPI	AssignUserRoles	Post /api/users/{userId}/roles	Assign roles to user
UsersAPI	CreateUser	Post /api/users	Create user
UsersAPI	CreateUserIdentity	Post /api/users/{userId}/identities	Link social identity to user
UsersAPI	CreateUserMfaVerification	Post /api/users/{userId}/mfa-verifications	Create an MFA verification for a user
UsersAPI	DeleteUser	Delete /api/users/{userId}	Delete user
UsersAPI	DeleteUserIdentity	Delete /api/users/{userId}/identities/{target}	Delete social identity from user
UsersAPI	DeleteUserMfaVerification	Delete /api/users/{userId}/mfa-verifications/{verificationId}	Delete an MFA verification for a user
UsersAPI	DeleteUserRole	Delete /api/users/{userId}/roles/{roleId}	Remove role from user
UsersAPI	GetUser	Get /api/users/{userId}	Get user
UsersAPI	GetUserHasPassword	Get /api/users/{userId}/has-password	Check if user has password
UsersAPI	ListUserCustomData	Get /api/users/{userId}/custom-data	Get user custom data
UsersAPI	ListUserMfaVerifications	Get /api/users/{userId}/mfa-verifications	Get user's MFA verifications
UsersAPI	ListUserOrganizations	Get /api/users/{userId}/organizations	Get organizations for a user
UsersAPI	ListUserRoles	Get /api/users/{userId}/roles	Get roles for user
UsersAPI	ListUsers	Get /api/users	Get users
UsersAPI	ReplaceUserIdentity	Put /api/users/{userId}/identities/{target}	Update social identity of user
UsersAPI	ReplaceUserRoles	Put /api/users/{userId}/roles	Update roles for user
UsersAPI	UpdateUser	Patch /api/users/{userId}	Update user
UsersAPI	UpdateUserCustomData	Patch /api/users/{userId}/custom-data	Update user custom data
UsersAPI	UpdateUserIsSuspended	Patch /api/users/{userId}/is-suspended	Update user suspension status
UsersAPI	UpdateUserPassword	Patch /api/users/{userId}/password	Update user password
UsersAPI	UpdateUserProfile	Patch /api/users/{userId}/profile	Update user profile
UsersAPI	VerifyUserPassword	Post /api/users/{userId}/password/verify	Verify user password
VerificationCodesAPI	CreateVerificationCode	Post /api/verification-codes	Request and send a verification code
VerificationCodesAPI	VerifyVerificationCode	Post /api/verification-codes/verify	Verify a verification code
WellKnownAPI	GetSignInExperienceConfig	Get /api/.well-known/sign-in-exp	Get full sign-in experience
WellKnownAPI	GetSignInExperiencePhrases	Get /api/.well-known/phrases	Get localized phrases

Documentation For Models

• AddOrganizationApplicationsRequest
• AddOrganizationUsersRequest
• ApiInteractionBindMfaPostRequest
• ApiInteractionBindMfaPostRequestOneOf
• ApiInteractionBindMfaPostRequestOneOf1
• ApiInteractionBindMfaPostRequestOneOf1ClientExtensionResults
• ApiInteractionBindMfaPostRequestOneOf1ClientExtensionResultsCrepProps
• ApiInteractionBindMfaPostRequestOneOf1Response
• ApiInteractionBindMfaPostRequestOneOf2
• ApiInteractionConsentGet200Response
• ApiInteractionConsentGet200ResponseApplication
• ApiInteractionConsentGet200ResponseApplicationBranding
• ApiInteractionConsentGet200ResponseOrganizationsInner
• ApiInteractionConsentGet200ResponseOrganizationsInnerMissingResourceScopesInner
• ApiInteractionConsentGet200ResponseOrganizationsInnerMissingResourceScopesInnerResource
• ApiInteractionConsentGet200ResponseOrganizationsInnerMissingResourceScopesInnerScopesInner
• ApiInteractionConsentGet200ResponseUser
• ApiInteractionConsentPostRequest
• ApiInteractionEventPutRequest
• ApiInteractionMfaPutRequest
• ApiInteractionMfaPutRequestOneOf
• ApiInteractionMfaPutRequestOneOf1
• ApiInteractionMfaPutRequestOneOfResponse
• ApiInteractionMfaSkippedPutRequest
• ApiInteractionPutRequest
• ApiInteractionPutRequestIdentifier
• ApiInteractionPutRequestIdentifierOneOf
• ApiInteractionPutRequestIdentifierOneOf1
• ApiInteractionPutRequestIdentifierOneOf2
• ApiInteractionPutRequestIdentifierOneOf3
• ApiInteractionPutRequestIdentifierOneOf4
• ApiInteractionPutRequestIdentifierOneOf5
• ApiInteractionPutRequestIdentifierOneOf6
• ApiInteractionPutRequestIdentifierOneOf7
• ApiInteractionPutRequestProfile
• ApiInteractionSingleSignOnConnectorIdAuthorizationUrlPostRequest
• ApiInteractionSubmitPost200Response
• ApiInteractionVerificationSocialAuthorizationUriPostRequest
• ApiInteractionVerificationTotpPost200Response
• ApiInteractionVerificationVerificationCodePostRequest
• ApiInteractionVerificationVerificationCodePostRequestOneOf
• ApiInteractionVerificationVerificationCodePostRequestOneOf1
• ApiInteractionVerificationWebauthnAuthenticationPost200Response
• ApiInteractionVerificationWebauthnRegistrationPost200Response
• ApiInteractionVerificationWebauthnRegistrationPost200ResponseAuthenticatorSelection
• ApiInteractionVerificationWebauthnRegistrationPost200ResponseExcludeCredentialsInner
• ApiInteractionVerificationWebauthnRegistrationPost200ResponseExtensions
• ApiInteractionVerificationWebauthnRegistrationPost200ResponsePubKeyCredParamsInner
• ApiInteractionVerificationWebauthnRegistrationPost200ResponseRp
• ApiInteractionVerificationWebauthnRegistrationPost200ResponseUser
• AssertSingleSignOnSamlRequest
• AssignApplicationRolesRequest
• AssignOrganizationRolesToApplicationRequest
• AssignOrganizationRolesToApplicationsRequest
• AssignOrganizationRolesToUserRequest
• AssignOrganizationRolesToUsersRequest
• CreateApplicationProtectedAppMetadataCustomDomainRequest
• CreateApplicationRequest
• CreateApplicationRequestProtectedAppMetadata
• CreateApplicationUserConsentOrganizationRequest
• CreateApplicationUserConsentScopeRequest
• CreateConnectorAuthorizationUri200Response
• CreateConnectorAuthorizationUriRequest
• CreateConnectorRequest
• CreateConnectorRequestMetadata
• CreateConnectorTestRequest
• CreateDomainRequest
• CreateHookRequest
• CreateHookRequestConfig
• CreateHookTestRequest
• CreateHookTestRequestConfig
• CreateOrganizationInvitationRequest
• CreateOrganizationInvitationRequestMessagePayload
• CreateOrganizationInvitationRequestMessagePayloadOneOf
• CreateOrganizationJitEmailDomainRequest
• CreateOrganizationJitRoleRequest
• CreateOrganizationJitSsoConnectorRequest
• CreateOrganizationRequest
• CreateOrganizationRoleRequest
• CreateOrganizationRoleResourceScopeRequest
• CreateOrganizationRoleScopeRequest
• CreateOrganizationScopeRequest
• CreateResourceRequest
• CreateResourceScopeRequest
• CreateRoleApplicationRequest
• CreateRoleRequest
• CreateRoleScopeRequest
• CreateRoleUserRequest
• CreateSsoConnectorRequest
• CreateUserAsset200Response
• CreateUserIdentityRequest
• CreateUserMfaVerification200Response
• CreateUserMfaVerification200ResponseOneOf
• CreateUserMfaVerification200ResponseOneOf1
• CreateUserMfaVerificationRequest
• CreateUserMfaVerificationRequestType
• CreateUserRequest
• GetActiveUserCounts200Response
• GetActiveUserCounts200ResponseDauCurveInner
• GetAdminConsoleConfig200Response
• GetAdminConsoleConfig200ResponseCheckedChargeNotification
• GetAdminConsoleConfig200ResponseDevelopmentTenantMigrationNotification
• GetApplication200Response
• GetApplicationSignInExperience200Response
• GetHasuraAuth200Response
• GetJwtCustomizer200Response
• GetJwtCustomizer200ResponseOneOf
• GetJwtCustomizer200ResponseOneOf1
• GetJwtCustomizer200ResponseOneOf1TokenSample
• GetJwtCustomizer200ResponseOneOfContextSample
• GetJwtCustomizer200ResponseOneOfContextSampleUser
• GetJwtCustomizer200ResponseOneOfContextSampleUserIdentitiesValue
• GetJwtCustomizer200ResponseOneOfContextSampleUserOrganizationRolesInner
• GetJwtCustomizer200ResponseOneOfContextSampleUserProfile
• GetJwtCustomizer200ResponseOneOfContextSampleUserProfileAddress
• GetJwtCustomizer200ResponseOneOfContextSampleUserRolesInner
• GetJwtCustomizer200ResponseOneOfContextSampleUserRolesInnerScopesInner
• GetJwtCustomizer200ResponseOneOfContextSampleUserRolesInnerScopesInnerResource
• GetJwtCustomizer200ResponseOneOfContextSampleUserSsoIdentitiesInner
• GetJwtCustomizer200ResponseOneOfTokenSample
• GetJwtCustomizer200ResponseOneOfTokenSampleAud
• GetNewUserCounts200Response
• GetNewUserCounts200ResponseToday
• GetOidcKeys200ResponseInner
• GetOrganizationInvitation200Response
• GetOrganizationRole200Response
• GetSignInExp200Response
• GetSignInExp200ResponseColor
• GetSignInExp200ResponseLanguageInfo
• GetSignInExp200ResponseMfa
• GetSignInExp200ResponsePasswordPolicy
• GetSignInExp200ResponsePasswordPolicyCharacterTypes
• GetSignInExp200ResponsePasswordPolicyLength
• GetSignInExp200ResponsePasswordPolicyRejects
• GetSignInExp200ResponseSignIn
• GetSignInExp200ResponseSignInMethodsInner
• GetSignInExp200ResponseSignUp
• GetSignInExp200ResponseSocialSignIn
• GetSignInExperienceConfig200Response
• GetSignInExperienceConfig200ResponseForgotPassword
• GetSignInExperienceConfig200ResponseGoogleOneTap
• GetSignInExperienceConfig200ResponseSocialConnectorsInner
• GetSignInExperienceConfig200ResponseSsoConnectorsInner
• GetSignInExperiencePhrases200ResponseValue
• GetSystemApplicationConfig200Response
• GetSystemApplicationConfig200ResponseProtectedApps
• GetTotalUserCount200Response
• GetUser200Response
• GetUser200ResponseSsoIdentitiesInner
• GetUserAssetServiceStatus200Response
• GetUserAssetServiceStatus200ResponseStatus
• GetUserHasPassword200Response
• ListApplicationOrganizations200ResponseInner
• ListApplicationOrganizations200ResponseInnerOrganizationRolesInner
• ListApplicationRoles200ResponseInner
• ListApplicationUserConsentOrganizations200Response
• ListApplicationUserConsentOrganizations200ResponseOrganizationsInner
• ListApplicationUserConsentScopes200Response
• ListApplicationUserConsentScopes200ResponseOrganizationScopesInner
• ListApplicationUserConsentScopes200ResponseResourceScopesInner
• ListApplicationUserConsentScopes200ResponseResourceScopesInnerResource
• ListApplications200ResponseInner
• ListApplications200ResponseInnerCustomClientMetadata
• ListApplications200ResponseInnerOidcClientMetadata
• ListApplications200ResponseInnerOidcClientMetadataRedirectUrisInner
• ListApplications200ResponseInnerProtectedAppMetadata
• ListApplications200ResponseInnerProtectedAppMetadataCustomDomainsInner
• ListApplications200ResponseInnerProtectedAppMetadataCustomDomainsInnerCloudflareData
• ListApplications200ResponseInnerProtectedAppMetadataCustomDomainsInnerCloudflareDataSsl
• ListApplications200ResponseInnerProtectedAppMetadataCustomDomainsInnerCloudflareDataSslValidationErrorsInner
• ListApplications200ResponseInnerProtectedAppMetadataCustomDomainsInnerDnsRecordsInner
• ListApplications200ResponseInnerProtectedAppMetadataPageRulesInner
• ListApplicationsIsThirdPartyParameter
• ListApplicationsTypesParameter
• ListConnectorFactories200ResponseInner
• ListConnectors200ResponseInner
• ListConnectors200ResponseInnerFormItemsInner
• ListConnectors200ResponseInnerFormItemsInnerOneOf
• ListConnectors200ResponseInnerFormItemsInnerOneOf1
• ListConnectors200ResponseInnerFormItemsInnerOneOf1SelectItemsInner
• ListConnectors200ResponseInnerFormItemsInnerOneOf2
• ListConnectors200ResponseInnerFormItemsInnerOneOfSelectItemsInner
• ListConnectors200ResponseInnerFormItemsInnerOneOfShowConditionsInner
• ListConnectors200ResponseInnerMetadata
• ListCustomPhrases200ResponseInner
• ListDomains200ResponseInner
• ListHookRecentLogs200ResponseInner
• ListHooks200ResponseInner
• ListHooks200ResponseInnerConfig
• ListHooks200ResponseInnerExecutionStats
• ListJwtCustomizers200ResponseInner
• ListJwtCustomizers200ResponseInnerOneOf
• ListJwtCustomizers200ResponseInnerOneOf1
• ListLogs200ResponseInner
• ListLogs200ResponseInnerPayload
• ListLogs200ResponseInnerPayloadError
• ListOrganizationApplications200ResponseInner
• ListOrganizationJitEmailDomains200ResponseInner
• ListOrganizationJitSsoConnectors200ResponseInner
• ListOrganizationJitSsoConnectors200ResponseInnerBranding
• ListOrganizationRoleScopes200ResponseInner
• ListOrganizationRoles200ResponseInner
• ListOrganizationRoles200ResponseInnerResourceScopesInner
• ListOrganizationUsers200ResponseInner
• ListOrganizations200ResponseInner
• ListResources200ResponseInner
• ListResources200ResponseInnerScopesInner
• ListRoleScopes200ResponseInner
• ListRoles200ResponseInner
• ListRoles200ResponseInnerFeaturedApplicationsInner
• ListRoles200ResponseInnerFeaturedUsersInner
• ListSsoConnectorProviders200ResponseInner
• ListSsoConnectors200ResponseInner
• ListUserMfaVerifications200ResponseInner
• ReplaceApplicationRolesRequest
• ReplaceApplicationSignInExperienceRequest
• ReplaceApplicationSignInExperienceRequestTermsOfUseUrl
• ReplaceApplicationUserConsentOrganizationsRequest
• ReplaceOrganizationApplicationRolesRequest
• ReplaceOrganizationApplicationsRequest
• ReplaceOrganizationInvitationStatusRequest
• ReplaceOrganizationJitEmailDomainsRequest
• ReplaceOrganizationJitRolesRequest
• ReplaceOrganizationJitSsoConnectorsRequest
• ReplaceOrganizationRoleResourceScopesRequest
• ReplaceOrganizationRoleScopesRequest
• ReplaceOrganizationUserRolesRequest
• ReplaceOrganizationUsersRequest
• ReplaceUserIdentityRequest
• RotateOidcKeysRequest
• TestJwtCustomizerRequest
• TestJwtCustomizerRequestOneOf
• TestJwtCustomizerRequestOneOf1
• TestJwtCustomizerRequestPayload
• Translation
• TranslationObject
• UpdateAdminConsoleConfigRequest
• UpdateApplicationRequest
• UpdateApplicationRequestOidcClientMetadata
• UpdateApplicationRequestProtectedAppMetadata
• UpdateConnectorRequest
• UpdateConnectorRequestMetadata
• UpdateHook200Response
• UpdateHookRequest
• UpdateOrganizationRequest
• UpdateOrganizationRoleRequest
• UpdateOrganizationScopeRequest
• UpdateResourceIsDefaultRequest
• UpdateResourceRequest
• UpdateResourceScopeRequest
• UpdateRoleRequest
• UpdateSignInExp200Response
• UpdateSignInExp200ResponseColor
• UpdateSignInExp200ResponseLanguageInfo
• UpdateSignInExp200ResponseMfa
• UpdateSignInExp200ResponsePasswordPolicy
• UpdateSignInExp200ResponseSignIn
• UpdateSignInExp200ResponseSignUp
• UpdateSignInExpRequest
• UpdateSignInExpRequestColor
• UpdateSignInExpRequestLanguageInfo
• UpdateSignInExpRequestSignIn
• UpdateSignInExpRequestSignUp
• UpdateSignInExpRequestTermsOfUseUrl
• UpdateSsoConnectorRequest
• UpdateUser200Response
• UpdateUserCustomDataRequest
• UpdateUserIsSuspendedRequest
• UpdateUserPasswordRequest
• UpdateUserProfileRequest
• UpdateUserProfileRequestProfile
• UpdateUserRequest
• UpdateUserRequestAvatar
• UpdateUserRequestName
• UpdateUserRequestPrimaryEmail
• UpdateUserRequestPrimaryPhone
• UpdateUserRequestUsername
• UpsertJwtCustomizerRequest
• VerifyUserPasswordRequest
• VerifyVerificationCodeRequest

Documentation For Authorization

Authentication schemes defined for the API:

ManagementApi

• Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), logto.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

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

Author