auth0
Version:
SDK for Auth0 API v2
371 lines (370 loc) • 21.3 kB
TypeScript
import * as runtime from '../../../lib/runtime.js';
import type { InitOverride, ApiResponse } from '../../../lib/runtime.js';
import type { DeletePermissionsRequest, DeleteUserIdentityByUserId200ResponseInner, DeleteUserRolesRequest, GetAuthenticationMethods200ResponseOneOfInner, GetFederatedConnectionsTokensets200ResponseInner, GetRefreshTokensForUser200Response, GetSessionsForUser200Response, GetUsers200ResponseOneOfInner, PatchAuthenticationMethodsByAuthenticationMethodIdRequest, PostAuthenticationMethods201Response, PostAuthenticationMethodsRequest, PostIdentitiesRequest, PostPermissionsRequest, PostRecoveryCodeRegeneration200Response, PostUserRolesRequest, PutAuthenticationMethods200ResponseInner, PutAuthenticationMethodsRequestInner, UserCreate, UserEnrollment, UserIdentity, UserUpdate, GetAuthenticationMethods200ResponseOneOf, GetLogs200ResponseOneOf, Log, GetPermissions200ResponseOneOf, GetPermissions200ResponseOneOfInner, GetOrganizations200ResponseOneOf, GetOrganizations200ResponseOneOfInner, GetOrganizationMemberRoles200ResponseOneOf, GetOrganizationMemberRoles200ResponseOneOfInner, GetUsers200ResponseOneOf, DeleteAuthenticationMethodsRequest, DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, DeleteAuthenticatorsRequest, DeleteFederatedConnectionsTokensetsByTokensetIdRequest, DeleteMultifactorByProviderRequest, DeletePermissionsOperationRequest, DeleteRefreshTokensForUserRequest, DeleteSessionsForUserRequest, DeleteUserIdentityByUserIdRequest, DeleteUserRolesOperationRequest, DeleteUsersByIdRequest, GetAuthenticationMethodsRequest, GetAuthenticationMethodsByAuthenticationMethodIdRequest, GetEnrollmentsRequest, GetFederatedConnectionsTokensetsRequest, GetLogsByUserRequest, GetPermissionsRequest, GetRefreshTokensForUserRequest, GetSessionsForUserRequest, GetUserOrganizationsRequest, GetUserRolesRequest, GetUsersRequest, GetUsersByIdRequest, PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, PatchUsersByIdRequest, PostAuthenticationMethodsOperationRequest, PostIdentitiesOperationRequest, PostInvalidateRememberBrowserRequest, PostPermissionsOperationRequest, PostRecoveryCodeRegenerationRequest, PostUserRolesOperationRequest, PutAuthenticationMethodsRequest } from '../models/index.js';
declare const BaseAPI: typeof runtime.BaseAPI;
/**
*
*/
export declare class UsersManager extends BaseAPI {
/**
* Deletes all authentication methods for the given user
*
* @throws {RequiredError}
*/
deleteAuthenticationMethods(requestParameters: DeleteAuthenticationMethodsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Deletes an authentication method by ID
*
* @throws {RequiredError}
*/
deleteAuthenticationMethod(requestParameters: DeleteAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Delete All Authenticators
*
* @throws {RequiredError}
*/
deleteAllAuthenticators(requestParameters: DeleteAuthenticatorsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Deletes a tokenset for federated connections by id.
*
* @throws {RequiredError}
*/
deleteTokenset(requestParameters: DeleteFederatedConnectionsTokensetsByTokensetIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Delete a <a href="https://auth0.com/docs/multifactor-authentication">multifactor</a> configuration for a user. This forces the user to re-configure the multi-factor provider.
* Delete a User's Multi-factor Provider
*
* @throws {RequiredError}
*/
deleteMultifactorProvider(requestParameters: DeleteMultifactorByProviderRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Remove permissions from a user.
*
* Remove Permissions from a User
*
* @throws {RequiredError}
*/
deletePermissions(requestParameters: DeletePermissionsOperationRequest, bodyParameters: DeletePermissionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Delete all refresh tokens for a user.
* Delete refresh tokens for a user
*
* @throws {RequiredError}
*/
deleteRefreshTokens(requestParameters: DeleteRefreshTokensForUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Delete all sessions for a user.
* Delete sessions for user
*
* @throws {RequiredError}
*/
deleteSessions(requestParameters: DeleteSessionsForUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Unlink an identity from the target user making it a separate user account again.
* Unlink a User Identity
*
* @throws {RequiredError}
*/
unlink(requestParameters: DeleteUserIdentityByUserIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<DeleteUserIdentityByUserId200ResponseInner>>>;
/**
* Remove roles from a user.
* Removes roles from a user
*
* @throws {RequiredError}
*/
deleteRoles(requestParameters: DeleteUserRolesOperationRequest, bodyParameters: DeleteUserRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Delete a user.
* Delete a User
*
* @throws {RequiredError}
*/
delete(requestParameters: DeleteUsersByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Gets a list of authentication methods
*
* @throws {RequiredError}
*/
getAuthenticationMethods(requestParameters: GetAuthenticationMethodsRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetAuthenticationMethods200ResponseOneOf>>;
getAuthenticationMethods(requestParameters?: GetAuthenticationMethodsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetAuthenticationMethods200ResponseOneOfInner>>>;
/**
* Gets an authentication method by ID.
*
* @throws {RequiredError}
*/
getAuthenticationMethod(requestParameters: GetAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetAuthenticationMethods200ResponseOneOfInner>>;
/**
* Retrieve the first confirmed <a href="https://auth0.com/docs/multifactor-authentication/guardian">Guardian</a> enrollment for a user.
* Get the First Confirmed Multi-factor Authentication Enrollment
*
* @throws {RequiredError}
*/
getEnrollments(requestParameters: GetEnrollmentsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<UserEnrollment>>>;
/**
* List active federated connections tokensets for a provided user
* Get tokensets for a user
*
* @throws {RequiredError}
*/
getAllTokensets(requestParameters: GetFederatedConnectionsTokensetsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetFederatedConnectionsTokensets200ResponseInner>>>;
/**
* Retrieve log events for a specific user.
*
* Note: For more information on all possible event types, their respective acronyms and descriptions, see <a href="https://auth0.com/docs/logs/log-event-type-codes">Log Event Type Codes</a>.
*
* For more information on the list of fields that can be used in `sort`, see <a href="https://auth0.com/docs/logs/log-search-query-syntax#searchable-fields">Searchable Fields</a>.
*
* Auth0 <a href="https://auth0.com/docs/logs/retrieve-log-events-using-mgmt-api#limitations">limits the number of logs</a> you can return by search criteria to 100 logs per request. Furthermore, you may only paginate through up to 1,000 search results. If you exceed this threshold, please redefine your search.
* Get user's log events
*
* @throws {RequiredError}
*/
getLogs(requestParameters: GetLogsByUserRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetLogs200ResponseOneOf>>;
getLogs(requestParameters?: GetLogsByUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<Log>>>;
/**
* Retrieve all permissions associated with the user.
* Get a User's Permissions
*
* @throws {RequiredError}
*/
getPermissions(requestParameters: GetPermissionsRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetPermissions200ResponseOneOf>>;
getPermissions(requestParameters?: GetPermissionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetPermissions200ResponseOneOfInner>>>;
/**
* Retrieve details for a user's refresh tokens.
* Get refresh tokens for a user
*
* @throws {RequiredError}
*/
getRefreshTokens(requestParameters: GetRefreshTokensForUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetRefreshTokensForUser200Response>>;
/**
* Retrieve details for a user's sessions.
* Get sessions for user
*
* @throws {RequiredError}
*/
getSessions(requestParameters: GetSessionsForUserRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetSessionsForUser200Response>>;
/**
* Retrieve list of the specified user's current Organization memberships. User must be specified by user ID. For more information, review <a href="https://auth0.com/docs/manage-users/organizations">Auth0 Organizations</a>.
*
* List user's organizations
*
* @throws {RequiredError}
*/
getUserOrganizations(requestParameters: GetUserOrganizationsRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizations200ResponseOneOf>>;
getUserOrganizations(requestParameters?: GetUserOrganizationsRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizations200ResponseOneOfInner>>>;
/**
* List the the roles associated with a user.
* Get a user's roles
*
* @throws {RequiredError}
*/
getRoles(requestParameters: GetUserRolesRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetOrganizationMemberRoles200ResponseOneOf>>;
getRoles(requestParameters?: GetUserRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetOrganizationMemberRoles200ResponseOneOfInner>>>;
/**
* Retrieve details of users. It is possible to:
*
* - Specify a search criteria for users
* - Sort the users to be returned
* - Select the fields to be returned
* - Specify the number of users to retrieve per page and the page index
* <!-- only v3 is available -->
* The <code>q</code> query parameter can be used to get users that match the specified criteria <a href="https://manage.local.dev.auth0.com/docs/users/search/v3/query-syntax">using query string syntax.</a>
*
* <a href="https://manage.local.dev.auth0.com/docs/users/search/v3">Learn more about searching for users.</a>
*
* Read about <a href="https://manage.local.dev.auth0.com/docs/users/search/best-practices">best practices</a> when working with the API endpoints for retrieving users.
*
* Auth0 limits the number of users you can return. If you exceed this threshold, please redefine your search, use the <a href="https://manage.local.dev.auth0.com/docs/api/management/v2#!/Jobs/post_users_exports">export job</a>, or the <a href="https://manage.local.dev.auth0.com/docs/extensions/user-import-export">User Import / Export</a> extension.
*
* List or Search Users
*
* @throws {RequiredError}
*/
getAll(requestParameters: GetUsersRequest & {
include_totals: true;
}, initOverrides?: InitOverride): Promise<ApiResponse<GetUsers200ResponseOneOf>>;
getAll(requestParameters?: GetUsersRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<GetUsers200ResponseOneOfInner>>>;
/**
* Retrieve user details. A list of fields to include or exclude may also be specified.
* Get a User
*
* @throws {RequiredError}
*/
get(requestParameters: GetUsersByIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<GetUsers200ResponseOneOfInner>>;
/**
* Updates an authentication method.
*
* @throws {RequiredError}
*/
updateAuthenticationMethod(requestParameters: PatchAuthenticationMethodsByAuthenticationMethodIdOperationRequest, bodyParameters: PatchAuthenticationMethodsByAuthenticationMethodIdRequest, initOverrides?: InitOverride): Promise<ApiResponse<PutAuthenticationMethods200ResponseInner>>;
/**
* Update a user.
*
* These are the attributes that can be updated at the root level:
*
* <ul>
* <li>app_metadata</li>
* <li>blocked</li>
* <li>email</li>
* <li>email_verified</li>
* <li>family_name</li>
* <li>given_name</li>
* <li>name</li>
* <li>nickname</li>
* <li>password</li>
* <li>phone_number</li>
* <li>phone_verified</li>
* <li>picture</li>
* <li>username</li>
* <li>user_metadata</li>
* <li>verify_email</li>
* </ul>
*
* Some considerations:
* <ul>
* <li>The properties of the new object will replace the old ones.</li>
* <li>The metadata fields are an exception to this rule (<code>user_metadata</code> and <code>app_metadata</code>). These properties are merged instead of being replaced but be careful, the merge only occurs on the first level.</li>
* <li>If you are updating <code>email</code>, <code>email_verified</code>, <code>phone_number</code>, <code>phone_verified</code>, <code>username</code> or <code>password</code> of a secondary identity, you need to specify the <code>connection</code> property too.</li>
* <li>If you are updating <code>email</code> or <code>phone_number</code> you can specify, optionally, the <code>client_id</code> property.</li>
* <li>Updating <code>email_verified</code> is not supported for enterprise and passwordless sms connections.</li>
* <li>Updating the <code>blocked</code> to <code>false</code> does not affect the user's blocked state from an excessive amount of incorrectly provided credentials. Use the "Unblock a user" endpoint from the "User Blocks" API to change the user's state.</li>
* </ul>
*
* <h5>Updating a field (non-metadata property)</h5>
* To mark the email address of a user as verified, the body to send should be:
* <pre><code>{ "email_verified": true }</code></pre>
*
* <h5>Updating a user metadata root property</h5>Let's assume that our test user has the following <code>user_metadata</code>:
* <pre><code>{ "user_metadata" : { "profileCode": 1479 } }</code></pre>
*
* To add the field <code>addresses</code> the body to send should be:
* <pre><code>{ "user_metadata" : { "addresses": {"work_address": "100 Industrial Way"} }}</code></pre>
*
* The modified object ends up with the following <code>user_metadata</code> property:<pre><code>{
* "user_metadata": {
* "profileCode": 1479,
* "addresses": { "work_address": "100 Industrial Way" }
* }
* }</code></pre>
*
* <h5>Updating an inner user metadata property</h5>If there's existing user metadata to which we want to add <code>"home_address": "742 Evergreen Terrace"</code> (using the <code>addresses</code> property) we should send the whole <code>addresses</code> object. Since this is a first-level object, the object will be merged in, but its own properties will not be. The body to send should be:
* <pre><code>{
* "user_metadata": {
* "addresses": {
* "work_address": "100 Industrial Way",
* "home_address": "742 Evergreen Terrace"
* }
* }
* }</code></pre>
*
* The modified object ends up with the following <code>user_metadata</code> property:
* <pre><code>{
* "user_metadata": {
* "profileCode": 1479,
* "addresses": {
* "work_address": "100 Industrial Way",
* "home_address": "742 Evergreen Terrace"
* }
* }
* }</code></pre>
*
* Update a User
*
* @throws {RequiredError}
*/
update(requestParameters: PatchUsersByIdRequest, bodyParameters: UserUpdate, initOverrides?: InitOverride): Promise<ApiResponse<GetUsers200ResponseOneOfInner>>;
/**
* Creates an authentication method for a given user. Authentication methods created via this endpoint will be auto confirmed and should already have verification completed.
*
* @throws {RequiredError}
*/
createAuthenticationMethod(requestParameters: PostAuthenticationMethodsOperationRequest, bodyParameters: PostAuthenticationMethodsRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostAuthenticationMethods201Response>>;
/**
* Link two user accounts together forming a primary and secondary relationship. On successful linking, the endpoint returns the new array of the primary account identities.
*
* Note: There are two ways of invoking the endpoint:
*
* <ul>
* <li>With the authenticated primary account's JWT in the Authorization header, which has the <code>update:current_user_identities</code> scope:
* <pre>
* POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
* Authorization: "Bearer PRIMARY_ACCOUNT_JWT"
* {
* "link_with": "SECONDARY_ACCOUNT_JWT"
* }
* </pre>
* In this case, only the <code>link_with</code> param is required in the body, which also contains the JWT obtained upon the secondary account's authentication.
* </li>
* <li>With a token generated by the API V2 containing the <code>update:users</code> scope:
* <pre>
* POST /api/v2/users/PRIMARY_ACCOUNT_USER_ID/identities
* Authorization: "Bearer YOUR_API_V2_TOKEN"
* {
* "provider": "SECONDARY_ACCOUNT_PROVIDER",
* "connection_id": "SECONDARY_ACCOUNT_CONNECTION_ID(OPTIONAL)",
* "user_id": "SECONDARY_ACCOUNT_USER_ID"
* }
* </pre>
* In this case you need to send <code>provider</code> and <code>user_id</code> in the body. Optionally you can also send the <code>connection_id</code> param which is suitable for identifying a particular database connection for the 'auth0' provider.
* </li>
* </ul>
* Link a User Account
*
* @throws {RequiredError}
*/
link(requestParameters: PostIdentitiesOperationRequest, bodyParameters: PostIdentitiesRequest, initOverrides?: InitOverride): Promise<ApiResponse<Array<UserIdentity>>>;
/**
* Invalidate all remembered browsers across all <a href="https://auth0.com/docs/multifactor-authentication">authentication factors</a> for a user.
* Invalidate All Remembered Browsers for Multi-factor Authentication
*
* @throws {RequiredError}
*/
invalidateRememberBrowser(requestParameters: PostInvalidateRememberBrowserRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Assign permissions to a user.
* Assign Permissions to a User
*
* @throws {RequiredError}
*/
assignPermissions(requestParameters: PostPermissionsOperationRequest, bodyParameters: PostPermissionsRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Remove the current <a href="https://auth0.com/docs/multifactor-authentication/guardian">multi-factor authentication</a> recovery code and generate a new one.
* Generate New Multi-factor Authentication Recovery Code
*
* @throws {RequiredError}
*/
regenerateRecoveryCode(requestParameters: PostRecoveryCodeRegenerationRequest, initOverrides?: InitOverride): Promise<ApiResponse<PostRecoveryCodeRegeneration200Response>>;
/**
* Associate roles with a user.
* Assign roles to a user
*
* @throws {RequiredError}
*/
assignRoles(requestParameters: PostUserRolesOperationRequest, bodyParameters: PostUserRolesRequest, initOverrides?: InitOverride): Promise<ApiResponse<void>>;
/**
* Create a new user for a given <a href="https://auth0.com/docs/connections/database">database</a> or <a href="https://auth0.com/docs/connections/passwordless">passwordless</a> connection.
*
* Note: <code>connection</code> is required but other parameters such as <code>email</code> and <code>password</code> are dependent upon the type of connection.
* Create a User
*
* @throws {RequiredError}
*/
create(bodyParameters: UserCreate, initOverrides?: InitOverride): Promise<ApiResponse<GetUsers200ResponseOneOfInner>>;
/**
* Updates all authentication methods by replacing them with the given ones.
*
* @throws {RequiredError}
*/
updateAuthenticationMethods(requestParameters: PutAuthenticationMethodsRequest, bodyParameters: Array<PutAuthenticationMethodsRequestInner>, initOverrides?: InitOverride): Promise<ApiResponse<Array<PutAuthenticationMethods200ResponseInner>>>;
}
export {};