UserServiceClient class

Annotations

• @GrpcServiceName.new('zitadel.user.v2.UserService')

Constructors

UserServiceClient(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

addHumanUser(AddHumanUserRequest request, {CallOptions? options}) → ResponseFuture<AddHumanUserResponse>

Create a new human user

addIDPLink(AddIDPLinkRequest request, {CallOptions? options}) → ResponseFuture<AddIDPLinkResponse>

Add link to an identity provider to an user

addKey(AddKeyRequest request, {CallOptions? options}) → ResponseFuture<AddKeyResponse>

Add a Key

addOTPEmail(AddOTPEmailRequest request, {CallOptions? options}) → ResponseFuture<AddOTPEmailResponse>

Add OTP Email for a user

addOTPSMS(AddOTPSMSRequest request, {CallOptions? options}) → ResponseFuture<AddOTPSMSResponse>

Add OTP SMS for a user

addPersonalAccessToken(AddPersonalAccessTokenRequest request, {CallOptions? options}) → ResponseFuture<AddPersonalAccessTokenResponse>

Add a Personal Access Token

addSecret(AddSecretRequest request, {CallOptions? options}) → ResponseFuture<AddSecretResponse>

Add a Users Secret

createInviteCode(CreateInviteCodeRequest request, {CallOptions? options}) → ResponseFuture<CreateInviteCodeResponse>

Create an invite code for a user

createPasskeyRegistrationLink(CreatePasskeyRegistrationLinkRequest request, {CallOptions? options}) → ResponseFuture<CreatePasskeyRegistrationLinkResponse>

Create a passkey registration link for a user

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

Create a User

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

Deactivate user

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

Delete user

deleteUserMetadata(DeleteUserMetadataRequest request, {CallOptions? options}) → ResponseFuture<DeleteUserMetadataResponse>

Delete User Metadata

generateRecoveryCodes(GenerateRecoveryCodesRequest request, {CallOptions? options}) → ResponseFuture<GenerateRecoveryCodesResponse>

Generate single-use recovery codes for a user

getUserByID(GetUserByIDRequest request, {CallOptions? options}) → ResponseFuture<GetUserByIDResponse>

User by ID

humanMFAInitSkipped(HumanMFAInitSkippedRequest request, {CallOptions? options}) → ResponseFuture<HumanMFAInitSkippedResponse>

MFA Init Skipped

listAuthenticationFactors(ListAuthenticationFactorsRequest request, {CallOptions? options}) → ResponseFuture<ListAuthenticationFactorsResponse>

listAuthenticationMethodTypes(ListAuthenticationMethodTypesRequest request, {CallOptions? options}) → ResponseFuture<ListAuthenticationMethodTypesResponse>

List all possible authentication methods of a user

listIDPLinks(ListIDPLinksRequest request, {CallOptions? options}) → ResponseFuture<ListIDPLinksResponse>

List links to an identity provider of an user

listKeys(ListKeysRequest request, {CallOptions? options}) → ResponseFuture<ListKeysResponse>

Search Keys

listPasskeys(ListPasskeysRequest request, {CallOptions? options}) → ResponseFuture<ListPasskeysResponse>

List passkeys of an user

listPersonalAccessTokens(ListPersonalAccessTokensRequest request, {CallOptions? options}) → ResponseFuture<ListPersonalAccessTokensResponse>

Search Personal Access Tokens

listUserMetadata(ListUserMetadataRequest request, {CallOptions? options}) → ResponseFuture<ListUserMetadataResponse>

List User Metadata

listUsers(ListUsersRequest request, {CallOptions? options}) → ResponseFuture<ListUsersResponse>

Search Users

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

Lock user

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

passwordReset(PasswordResetRequest request, {CallOptions? options}) → ResponseFuture<PasswordResetResponse>

Request a code to reset a password

reactivateUser(ReactivateUserRequest request, {CallOptions? options}) → ResponseFuture<ReactivateUserResponse>

Reactivate user

registerPasskey(RegisterPasskeyRequest request, {CallOptions? options}) → ResponseFuture<RegisterPasskeyResponse>

Start the registration of passkey for a user

registerTOTP(RegisterTOTPRequest request, {CallOptions? options}) → ResponseFuture<RegisterTOTPResponse>

Start the registration of a TOTP generator for a user

registerU2F(RegisterU2FRequest request, {CallOptions? options}) → ResponseFuture<RegisterU2FResponse>

Start the registration of a u2f token for a user

removeIDPLink(RemoveIDPLinkRequest request, {CallOptions? options}) → ResponseFuture<RemoveIDPLinkResponse>

Remove link of an identity provider to an user

removeKey(RemoveKeyRequest request, {CallOptions? options}) → ResponseFuture<RemoveKeyResponse>

Remove a Key

removeOTPEmail(RemoveOTPEmailRequest request, {CallOptions? options}) → ResponseFuture<RemoveOTPEmailResponse>

Remove One-Time Password (OTP) Email from a user

removeOTPSMS(RemoveOTPSMSRequest request, {CallOptions? options}) → ResponseFuture<RemoveOTPSMSResponse>

Remove One-Time Password (OTP) SMS from a user

removePasskey(RemovePasskeyRequest request, {CallOptions? options}) → ResponseFuture<RemovePasskeyResponse>

Remove passkey from a user

removePersonalAccessToken(RemovePersonalAccessTokenRequest request, {CallOptions? options}) → ResponseFuture<RemovePersonalAccessTokenResponse>

Remove a Personal Access Token

removePhone(RemovePhoneRequest request, {CallOptions? options}) → ResponseFuture<RemovePhoneResponse>

Delete the user phone

removeRecoveryCodes(RemoveRecoveryCodesRequest request, {CallOptions? options}) → ResponseFuture<RemoveRecoveryCodesResponse>

Remove recovery codes from a user

removeSecret(RemoveSecretRequest request, {CallOptions? options}) → ResponseFuture<RemoveSecretResponse>

Remove a Users Secret

removeTOTP(RemoveTOTPRequest request, {CallOptions? options}) → ResponseFuture<RemoveTOTPResponse>

Remove TOTP generator from a user

removeU2F(RemoveU2FRequest request, {CallOptions? options}) → ResponseFuture<RemoveU2FResponse>

Remove u2f token from a user

resendEmailCode(ResendEmailCodeRequest request, {CallOptions? options}) → ResponseFuture<ResendEmailCodeResponse>

Resend code to verify user email

resendInviteCode(ResendInviteCodeRequest request, {CallOptions? options}) → ResponseFuture<ResendInviteCodeResponse>

Resend an invite code for a user

resendPhoneCode(ResendPhoneCodeRequest request, {CallOptions? options}) → ResponseFuture<ResendPhoneCodeResponse>

Resend code to verify user phone number

retrieveIdentityProviderIntent(RetrieveIdentityProviderIntentRequest request, {CallOptions? options}) → ResponseFuture<RetrieveIdentityProviderIntentResponse>

Retrieve the information returned by the identity provider

sendEmailCode(SendEmailCodeRequest request, {CallOptions? options}) → ResponseFuture<SendEmailCodeResponse>

Send code to verify user email

setEmail(SetEmailRequest request, {CallOptions? options}) → ResponseFuture<SetEmailResponse>

Change the user email

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

Change password

setPhone(SetPhoneRequest request, {CallOptions? options}) → ResponseFuture<SetPhoneResponse>

Set the user phone

setUserMetadata(SetUserMetadataRequest request, {CallOptions? options}) → ResponseFuture<SetUserMetadataResponse>

Set User Metadata

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

Start flow with an identity provider

toString() → String

A string representation of this object.

inherited

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

Unlock user

updateHumanUser(UpdateHumanUserRequest request, {CallOptions? options}) → ResponseFuture<UpdateHumanUserResponse>

Update Human User

updateUser(UpdateUserRequest request, {CallOptions? options}) → ResponseFuture<UpdateUserResponse>

Update a User

verifyEmail(VerifyEmailRequest request, {CallOptions? options}) → ResponseFuture<VerifyEmailResponse>

Verify the email

verifyInviteCode(VerifyInviteCodeRequest request, {CallOptions? options}) → ResponseFuture<VerifyInviteCodeResponse>

Verify an invite code for a user

verifyPasskeyRegistration(VerifyPasskeyRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyPasskeyRegistrationResponse>

Verify a passkey for a user

verifyPhone(VerifyPhoneRequest request, {CallOptions? options}) → ResponseFuture<VerifyPhoneResponse>

Verify the phone number

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

Verify a TOTP generator for a user

verifyU2FRegistration(VerifyU2FRegistrationRequest request, {CallOptions? options}) → ResponseFuture<VerifyU2FRegistrationResponse>

Verify a u2f token for a user

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.