Type Alias UsersAPI

type UsersAPI = {
    clearCache: typeof clearCache;
    countUsers: typeof countUsers;
    createUser: typeof createUser;
    deleteUser: typeof deleteUser;
    filterUsers: typeof filterUsers;
    getMyUser: typeof getMyUser;
    getUser: typeof getUser;
    getUsers: typeof getUsers;
    inviteUsers: typeof inviteUsers;
    patchUser: typeof patchUser;
}
Index

Properties

clearCache countUsers createUser deleteUser filterUsers getMyUser getUser getUsers inviteUsers patchUser

Properties

clearCache: typeof clearCache

Clears the cache for users api requests.

countUsers: typeof countUsers

Returns the number of users in a given tenant

an object with query parameters

CountUsersHttpError

createUser: typeof createUser

Creates an invited user.

Param: body

an object with the body content

CreateUserHttpError

deleteUser: typeof deleteUser

Deletes the requested user.

The ID of the user to delete.

DeleteUserHttpError

filterUsers: typeof filterUsers

Retrieves a list of users matching the filter using an advanced query string.

an object with query parameters

Param: body

an object with the body content

FilterUsersHttpError

getMyUser: typeof getMyUser

Redirects to retrieve the user resource associated with the JWT claims.

GetMyUserHttpError

getUser: typeof getUser

Returns the requested user.

The user's unique identifier

an object with query parameters

GetUserHttpError

getUsers: typeof getUsers

Returns a list of users using cursor-based pagination.

an object with query parameters

GetUsersHttpError

inviteUsers: typeof inviteUsers

Invite one or more users by email address.

Param: body

an object with the body content

InviteUsersHttpError

patchUser: typeof patchUser

Updates fields for a user resource

The ID of the user to update.

Param: body

an object with the body content

PatchUserHttpError

Settings

Member Visibility

On This Page

Properties