UsersApi class
Constructors
UsersApi (Dio _dio , Serializers _serializers
const
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
createUser ({CreateUserRequest ?createUserRequest , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<CreateUserResponse >
Create User
Creates a user record and optionally zero or more identities for the user. An example identity could be the email address of the user.
deleteUser ({required String id , bool ?isDeleteProfile , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<SuccessResponse >
Delete User
Delete a user record.
getUserData ({required String id , String ?expand , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<User >
Get User
Retrieve a user record.
getUsers ({String ?sort , int ?pageSize , String ?userId , String ?nextToken , String ?email , String ?expand , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<UsersResponse >
List Users
The returned list can be sorted by full name or email address in ascending or descending order. The number of records to return at a time can also be controlled using the `page_size` query string parameter.
noSuchMethod (Invocation invocation → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
refreshUserClaims ({required String userId , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<SuccessResponse >
Refresh User Claims and Invalidate Cache
Refreshes the user's claims and invalidates the current cache.
toString ()
→ String
A string representation of this object.
inherited
updateUser ({required UpdateUserRequest updateUserRequest , String ?id , CancelToken? cancelToken , ValidateStatus? validateStatus , ProgressCallback? onSendProgress , ProgressCallback? onReceiveProgress → Future <Response<UpdateUserResponse > >
Update User
Update a user record.
