Module ory_client::apis::identity_api

Enums

• BatchPatchIdentitiesError
  struct for typed errors of method batch_patch_identities
• CreateIdentityError
  struct for typed errors of method create_identity
• CreateRecoveryCodeForIdentityError
  struct for typed errors of method create_recovery_code_for_identity
• CreateRecoveryLinkForIdentityError
  struct for typed errors of method create_recovery_link_for_identity
• DeleteIdentityCredentialsError
  struct for typed errors of method delete_identity_credentials
• DeleteIdentityError
  struct for typed errors of method delete_identity
• DeleteIdentitySessionsError
  struct for typed errors of method delete_identity_sessions
• DisableSessionError
  struct for typed errors of method disable_session
• ExtendSessionError
  struct for typed errors of method extend_session
• GetIdentityError
  struct for typed errors of method get_identity
• GetIdentitySchemaError
  struct for typed errors of method get_identity_schema
• GetSessionError
  struct for typed errors of method get_session
• ListIdentitiesError
  struct for typed errors of method list_identities
• ListIdentitySchemasError
  struct for typed errors of method list_identity_schemas
• ListIdentitySessionsError
  struct for typed errors of method list_identity_sessions
• ListSessionsError
  struct for typed errors of method list_sessions
• PatchIdentityError
  struct for typed errors of method patch_identity
• UpdateIdentityError
  struct for typed errors of method update_identity

Functions

• batch_patch_identities
  Creates or delete multiple identities. This endpoint can also be used to import credentials for instance passwords, social sign in configurations or multifactor methods.
• create_identity
  Create an identity. This endpoint can also be used to import credentials for instance passwords, social sign in configurations or multifactor methods.
• create_recovery_code_for_identity
  This endpoint creates a recovery code which should be given to the user in order for them to recover (or activate) their account.
• create_recovery_link_for_identity
  This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
• delete_identity
  Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already.
• delete_identity_credentials
  Delete an identity credential by its type You can only delete second factor (aal2) credentials.
• delete_identity_sessions
  Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
• disable_session
  Calling this endpoint deactivates the specified session. Session data is not deleted.
• extend_session
  Calling this endpoint extends the given session ID. If session.earliest_possible_extend is set it will only extend the session after the specified time has passed. Retrieve the session ID from the /sessions/whoami endpoint / toSession SDK method.
• get_identity
  Return an identity by its ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the include_credential query parameter.
• get_identity_schema
  Return a specific identity schema.
• get_session
  This endpoint is useful for: Getting a session object with all specified expandables that exist in an administrative context.
• list_identities
  Lists all identities in the system.
• list_identity_schemas
  Returns a list of all identity schemas currently in use.
• list_identity_sessions
  This endpoint returns all sessions that belong to the given Identity.
• list_sessions
  Listing all sessions that exist.
• patch_identity
  Partially updates an identity’s field using JSON Patch. The fields id, stateChangedAt and credentials can not be updated using this method.
• update_identity
  This endpoint updates an identity. The full identity payload (except credentials) is expected. It is possible to update the identity’s credentials as well.