AdminClient class
AdminService provides an SDK to talk with the Auth3 IdP Administrative API. Authorize request by passing a token. Token can be obtained using one of the methods described here: https://docs.auth3.dev/products/identity-platform/main.
You can use AdminClient on native platforms like this:
var example = AdminClient(url: MY_PROJECT_ID + '.admin.auth3.dev:443', token: '<token>');
var result = example.getConnections();
You can use AdminClient on web platforms like this:
var example = AdminClient(url: 'https://' + MY_PROJECT_ID + '.api.auth3.dev', token: '<token>');
var result = example.getConnections();
Constructors
- AdminClient({String url, String token})
- Set the API url within the constructor. This url will be passed down to the native gRPC client and will reinit itself if it's changed from the last time you called it.
Properties
- hashCode → int
-
The hash code for this object.
read-onlyinherited
- options → CallOptions
-
read-only
- runtimeType → Type
-
A representation of the runtime type of the object.
read-onlyinherited
- token ↔ String
-
read / write
- url ↔ String
-
read / write
Methods
-
createConnection(
{String name, String clientId, String clientSecret, String buttonImageUrl, String oidcDiscoveryUrl, String scopes, CreateConnectionRequest_Providers provider, List< String> mfa, CreateConnectionRequest_Types type}) → Future<CreateConnectionResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#createconnection
-
createIdentity(
{String schemaId, String connectionId, Map< String, dynamic> data}) → Future<CreateIdentityResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#createidentity
-
createIdSchema(
{String name, Map< String, dynamic> content}) → Future<CreateIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#createidschema
-
createOAuth2Client(
{List< String> allowedCorsOrigins, List<String> audience, bool backchannelLogoutSessionRequired, String backchannelLogoutUri, String clientName, String clientSecret, String clientUri, List<String> contacts, bool frontchannelLogoutSessionRequired, String frontchannelLogoutUri, List<GrantType> grantTypes, Map<String, dynamic> jwks, String jwksUri, String logoUri, Map<String, dynamic> metadata, String owner, String policyUri, List<String> postLogoutRedirectUris, List<String> redirectUris, RequestObjectSigningAlg requestObjectSigningAlg, List<String> requestUris, List<ResponseType> responseTypes, String scope, String sectorIdentifierUri, SubjectType subjectType, TokenEndpointAuthMethod tokenEndpointAuthMethod, TokenEndpointAuthSigningAlg tokenEndpointAuthSigningAlg, String tosUri, UserinfoSignedResponseAlg userinfoSignedResponseAlg, ClientType clientType}) → Future<CreateOAuth2ClientResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#createoauth2clients
-
deleteConnection(
{String id}) → Future< DeleteConnectionResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#deleteconnection
-
deleteIdentity(
{String id}) → Future< DeleteIdentityResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#deleteidentity
-
deleteIdSchema(
{String id}) → Future< DeleteIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#deleteidschema
-
deleteOAuth2Client(
{String clientId}) → Future< DeleteOAuth2ClientResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#deleteoauth2clients
-
getAddress(
{String id, String verification}) → Future< GetAddressResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getaddress
-
getAddresses(
{String identityId}) → Future< GetAddressesResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getaddresses
-
getConnections(
) → Future< GetConnectionsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getconnections
-
getCredentials(
{String identityId}) → Future< GetCredentialsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getcredentials
-
getDefaultIdSchema(
) → Future< GetDefaultIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getdefaultidschema
-
getEmailsSetup(
) → Future< GetEmailsSetupResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getemailssetup
-
getIdentities(
) → Future< GetIdentitiesResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidentities
-
getIdentitiesByAttribute(
{String attribute, String value}) → Future< GetIdentitiesByAttributeResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidentitiesbyattribute
-
getIdentity(
{String identityId}) → Future< GetIdentityResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidentity
-
getIdentityLoginAttempts(
{String identityId}) → Future< GetIdentityLoginAttemptsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidentityloginattempts
-
getIdSchema(
{String id}) → Future< GetIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidschema
-
getIdSchemas(
) → Future< GetIdSchemasResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getidschemas
-
getOAuth2Clients(
) → Future< GetOAuth2ClientsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getoauth2clients
-
getTraits(
{String identityId}) → Future< GetTraitsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#gettraits
-
getUserBaseStatistics(
{int daysBefore}) → Future< GetUserBaseStatisticsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#getuserbasestatistics
-
markDefaultIdSchema(
{String id}) → Future< MarkDefaultIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#markdefaultidschema
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a non-existent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
-
updateAddress(
{String id, bool verified, String address}) → Future< UpdateAddressResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateaddress
-
updateConnection(
{String id, String name, String clientId, String clientSecret, String buttonImageUrl, String oidcDiscoveryUrl, String scopes, UpdateConnectionRequest_Providers provider, List< String> mfa, UpdateConnectionRequest_Types type}) → Future<UpdateConnectionResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateconnection
-
updateCredential(
{String identityId, String connectionName, Map< String, dynamic> data}) → Future<UpdateCredentialResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updatecredential
-
updateEmailsSetup(
{String welcomeTitle, String welcomeTemplate, String accountVerificationTitle, String accountVerificationTemplate, String accountRecoveryTitle, String accountRecoveryTemplate, String accountRecoveredTitle, String accountRecoveredTemplate, String otpTitle, String otpTemplate, String emailAddress, String smtpHost, int smtpPort, String smtpUsername, String smtpPassword}) → Future< UpdateEmailsSetupResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateemailssetup
-
updateIdentity(
{String identityId, UpdateIdentityRequest_Lock lock}) → Future< UpdateIdentityResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateidentity
-
updateIdSchema(
{String id, String name, Map< String, dynamic> content}) → Future<UpdateIdSchemaResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateidschema
-
updateOAuth2Client(
{List< String> allowedCorsOrigins, List<String> audience, bool backchannelLogoutSessionRequired, String backchannelLogoutUri, String clientName, String clientSecret, String clientUri, List<String> contacts, bool frontchannelLogoutSessionRequired, String frontchannelLogoutUri, List<GrantType> grantTypes, Map<String, dynamic> jwks, String jwksUri, String logoUri, Map<String, dynamic> metadata, String owner, String policyUri, List<String> postLogoutRedirectUris, List<String> redirectUris, RequestObjectSigningAlg requestObjectSigningAlg, List<String> requestUris, List<ResponseType> responseTypes, String scope, String sectorIdentifierUri, SubjectType subjectType, TokenEndpointAuthMethod tokenEndpointAuthMethod, TokenEndpointAuthSigningAlg tokenEndpointAuthSigningAlg, String tosUri, UserinfoSignedResponseAlg userinfoSignedResponseAlg, String clientId}) → Future<UpdateOAuth2ClientResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updateoauth2clients
-
updateTraits(
{String identityId, String traits}) → Future< UpdateTraitsResponse> - Please refer to https://docs.auth3.dev/apis/identity-platform/administrative#updatetraits
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited