ZITADELUsersClient class

Annotations

• @GrpcServiceName.new('zitadel.resources.user.v3alpha.ZITADELUsers')

Constructors

ZITADELUsersClient(ClientChannel channel, {CallOptions? options, Iterable<ClientInterceptor>? interceptors})

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

$createCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ClientCall<Q, R>

inherited

$createStreamingCall<Q, R>(ClientMethod<Q, R> method, Stream<Q> requests, {CallOptions? options}) → ResponseStream<R>

inherited

$createUnaryCall<Q, R>(ClientMethod<Q, R> method, Q request, {CallOptions? options}) → ResponseFuture<R>

inherited

activateUser(ActivateUserRequest request, {CallOptions? options}) → ResponseFuture<ActivateUserResponse>

Activate a user

addIDPAuthenticator(AddIDPAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<AddIDPAuthenticatorResponse>

Add an IDP authenticator to a user

addOTPEmailAuthenticator(AddOTPEmailAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<AddOTPEmailAuthenticatorResponse>

Add a OTP Email authenticator

addOTPSMSAuthenticator(AddOTPSMSAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<AddOTPSMSAuthenticatorResponse>

Add a OTP SMS authenticator

addUsername(AddUsernameRequest request, {CallOptions? options}) → ResponseFuture<AddUsernameResponse>

Add a username

createUser(CreateUserRequest request, {CallOptions? options}) → ResponseFuture<CreateUserResponse>

Create a user

createWebAuthNRegistrationLink(CreateWebAuthNRegistrationLinkRequest request, {CallOptions? options}) → ResponseFuture<CreateWebAuthNRegistrationLinkResponse>

Create a WebAuthN registration link

deactivateUser(DeactivateUserRequest request, {CallOptions? options}) → ResponseFuture<DeactivateUserResponse>

Deactivate a user

deleteUser(DeleteUserRequest request, {CallOptions? options}) → ResponseFuture<DeleteUserResponse>

Delete a user

getIdentityProviderIntent(GetIdentityProviderIntentRequest request, {CallOptions? options}) → ResponseFuture<GetIdentityProviderIntentResponse>

Get the information of the IDP authentication intent

getUser(GetUserRequest request, {CallOptions? options}) → ResponseFuture<GetUserResponse>

User by ID

lockUser(LockUserRequest request, {CallOptions? options}) → ResponseFuture<LockUserResponse>

Lock a user

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

patchUser(PatchUserRequest request, {CallOptions? options}) → ResponseFuture<PatchUserResponse>

Patch a user

removeIDPAuthenticator(RemoveIDPAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<RemoveIDPAuthenticatorResponse>

Remove an IDP authenticator

removeOTPEmailAuthenticator(RemoveOTPEmailAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<RemoveOTPEmailAuthenticatorResponse>

Remove a OTP Email authenticator

removeOTPSMSAuthenticator(RemoveOTPSMSAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<RemoveOTPSMSAuthenticatorResponse>

Remove a OTP SMS authenticator

removeTOTPAuthenticator(RemoveTOTPAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<RemoveTOTPAuthenticatorResponse>

Remove a TOTP authenticator

removeUsername(RemoveUsernameRequest request, {CallOptions? options}) → ResponseFuture<RemoveUsernameResponse>

Remove a username

removeWebAuthNAuthenticator(RemoveWebAuthNAuthenticatorRequest request, {CallOptions? options}) → ResponseFuture<RemoveWebAuthNAuthenticatorResponse>

Remove a WebAuthN authenticator

requestPasswordReset(RequestPasswordResetRequest request, {CallOptions? options}) → ResponseFuture<RequestPasswordResetResponse>

Request password reset

resendContactEmailCode(ResendContactEmailCodeRequest request, {CallOptions? options}) → ResponseFuture<ResendContactEmailCodeResponse>

Resend the contact email code

resendContactPhoneCode(ResendContactPhoneCodeRequest request, {CallOptions? options}) → ResponseFuture<ResendContactPhoneCodeResponse>

Resend the contact phone code

searchUsers(SearchUsersRequest request, {CallOptions? options}) → ResponseFuture<SearchUsersResponse>

Search users

setContactEmail(SetContactEmailRequest request, {CallOptions? options}) → ResponseFuture<SetContactEmailResponse>

Set contact email

setContactPhone(SetContactPhoneRequest request, {CallOptions? options}) → ResponseFuture<SetContactPhoneResponse>

Set contact phone

setPassword(SetPasswordRequest request, {CallOptions? options}) → ResponseFuture<SetPasswordResponse>

Set a password

startIdentityProviderIntent(StartIdentityProviderIntentRequest request, {CallOptions? options}) → ResponseFuture<StartIdentityProviderIntentResponse>

Start an IDP authentication intent

startTOTPRegistration(StartTOTPRegistrationRequest request, {CallOptions? options}) → ResponseFuture<StartTOTPRegistrationResponse>

Start a TOTP registration

startWebAuthNRegistration(StartWebAuthNRegistrationRequest request, {CallOptions? options}) → ResponseFuture<StartWebAuthNRegistrationResponse>

Start a WebAuthN registration

toString() → String

A string representation of this object.

inherited

unlockUser(UnlockUserRequest request, {CallOptions? options}) → ResponseFuture<UnlockUserResponse>

Unlock a user

verifyContactEmail(VerifyContactEmailRequest request, {CallOptions? options}) → ResponseFuture<VerifyContactEmailResponse>

Verify the contact email

verifyContactPhone(VerifyContactPhoneRequest request, {CallOptions? options}) → ResponseFuture<VerifyContactPhoneResponse>

Verify the contact phone

verifyOTPEmailRegistration(VerifyOTPEmailRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyOTPEmailRegistrationResponse>

Verify OTP Email registration

verifyOTPSMSRegistration(VerifyOTPSMSRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyOTPSMSRegistrationResponse>

Verify OTP SMS registration

verifyTOTPRegistration(VerifyTOTPRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyTOTPRegistrationResponse>

Verify a TOTP registration

verifyWebAuthNRegistration(VerifyWebAuthNRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyWebAuthNRegistrationResponse>

Verify a WebAuthN registration

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

defaultHost → const String

The hostname for this service.

oauthScopes → const List<String>

OAuth scopes needed for the client.