Package sh.ory.api

Class V0alpha2Api

java.lang.Object
sh.ory.api.V0alpha2Api
public class V0alpha2Api
extends Object

  • Constructor Details

    • V0alpha2Api

      public V0alpha2Api()

    • V0alpha2Api

      public V0alpha2Api​(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient​(ApiClient apiClient)

    • getHostIndex

      public int getHostIndex()

    • setHostIndex

      public void setHostIndex​(int hostIndex)

    • getCustomBaseUrl

      public String getCustomBaseUrl()

    • setCustomBaseUrl

      public void setCustomBaseUrl​(String customBaseUrl)

    • adminCreateIdentityCall

      public okhttp3.Call adminCreateIdentityCall​(AdminCreateIdentityBody adminCreateIdentityBody, ApiCallback _callback) throws ApiException
      Build call for adminCreateIdentity
      Parameters:
      adminCreateIdentityBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 identity -
      400 jsonError -
      409 jsonError -
      500 jsonError -

    • adminCreateIdentity

      public Identity adminCreateIdentity​(AdminCreateIdentityBody adminCreateIdentityBody) throws ApiException
      Create an Identity This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      adminCreateIdentityBody - (optional)
      Returns:
      Identity
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 identity -
      400 jsonError -
      409 jsonError -
      500 jsonError -

    • adminCreateIdentityWithHttpInfo

      public ApiResponse<Identity> adminCreateIdentityWithHttpInfo​(AdminCreateIdentityBody adminCreateIdentityBody) throws ApiException
      Create an Identity This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      adminCreateIdentityBody - (optional)
      Returns:
      ApiResponse<Identity>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 identity -
      400 jsonError -
      409 jsonError -
      500 jsonError -

    • adminCreateIdentityAsync

      public okhttp3.Call adminCreateIdentityAsync​(AdminCreateIdentityBody adminCreateIdentityBody, ApiCallback<Identity> _callback) throws ApiException
      Create an Identity (asynchronously) This endpoint creates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      adminCreateIdentityBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 identity -
      400 jsonError -
      409 jsonError -
      500 jsonError -

    • adminCreateSelfServiceRecoveryLinkCall

      public okhttp3.Call adminCreateSelfServiceRecoveryLinkCall​(AdminCreateSelfServiceRecoveryLinkBody adminCreateSelfServiceRecoveryLinkBody, ApiCallback _callback) throws ApiException
      Build call for adminCreateSelfServiceRecoveryLink
      Parameters:
      adminCreateSelfServiceRecoveryLinkBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryLink -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminCreateSelfServiceRecoveryLink

      public SelfServiceRecoveryLink adminCreateSelfServiceRecoveryLink​(AdminCreateSelfServiceRecoveryLinkBody adminCreateSelfServiceRecoveryLinkBody) throws ApiException
      Create a Recovery Link This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
      Parameters:
      adminCreateSelfServiceRecoveryLinkBody - (optional)
      Returns:
      SelfServiceRecoveryLink
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryLink -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminCreateSelfServiceRecoveryLinkWithHttpInfo

      public ApiResponse<SelfServiceRecoveryLink> adminCreateSelfServiceRecoveryLinkWithHttpInfo​(AdminCreateSelfServiceRecoveryLinkBody adminCreateSelfServiceRecoveryLinkBody) throws ApiException
      Create a Recovery Link This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
      Parameters:
      adminCreateSelfServiceRecoveryLinkBody - (optional)
      Returns:
      ApiResponse<SelfServiceRecoveryLink>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryLink -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminCreateSelfServiceRecoveryLinkAsync

      public okhttp3.Call adminCreateSelfServiceRecoveryLinkAsync​(AdminCreateSelfServiceRecoveryLinkBody adminCreateSelfServiceRecoveryLinkBody, ApiCallback<SelfServiceRecoveryLink> _callback) throws ApiException
      Create a Recovery Link (asynchronously) This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.
      Parameters:
      adminCreateSelfServiceRecoveryLinkBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryLink -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentityCall

      public okhttp3.Call adminDeleteIdentityCall​(String id, ApiCallback _callback) throws ApiException
      Build call for adminDeleteIdentity
      Parameters:
      id - ID is the identity's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentity

      public void adminDeleteIdentity​(String id) throws ApiException
      Delete an 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. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID is the identity's ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentityWithHttpInfo

      public ApiResponse<Void> adminDeleteIdentityWithHttpInfo​(String id) throws ApiException
      Delete an 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. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID is the identity's ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentityAsync

      public okhttp3.Call adminDeleteIdentityAsync​(String id, ApiCallback<Void> _callback) throws ApiException
      Delete an Identity (asynchronously) 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. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID is the identity's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentitySessionsCall

      public okhttp3.Call adminDeleteIdentitySessionsCall​(String id, ApiCallback _callback) throws ApiException
      Build call for adminDeleteIdentitySessions
      Parameters:
      id - ID is the identity's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentitySessions

      public void adminDeleteIdentitySessions​(String id) throws ApiException
      Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. This endpoint is useful for: To forcefully logout Identity from all devices and sessions
      Parameters:
      id - ID is the identity's ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentitySessionsWithHttpInfo

      public ApiResponse<Void> adminDeleteIdentitySessionsWithHttpInfo​(String id) throws ApiException
      Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. This endpoint is useful for: To forcefully logout Identity from all devices and sessions
      Parameters:
      id - ID is the identity's ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminDeleteIdentitySessionsAsync

      public okhttp3.Call adminDeleteIdentitySessionsAsync​(String id, ApiCallback<Void> _callback) throws ApiException
      Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. (asynchronously) This endpoint is useful for: To forcefully logout Identity from all devices and sessions
      Parameters:
      id - ID is the identity's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminExtendSessionCall

      public okhttp3.Call adminExtendSessionCall​(String id, ApiCallback _callback) throws ApiException
      Build call for adminExtendSession
      Parameters:
      id - ID is the session's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminExtendSession

      public Session adminExtendSession​(String id) throws ApiException
      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.
      Parameters:
      id - ID is the session's ID. (required)
      Returns:
      Session
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminExtendSessionWithHttpInfo

      public ApiResponse<Session> adminExtendSessionWithHttpInfo​(String id) throws ApiException
      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.
      Parameters:
      id - ID is the session's ID. (required)
      Returns:
      ApiResponse<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminExtendSessionAsync

      public okhttp3.Call adminExtendSessionAsync​(String id, ApiCallback<Session> _callback) throws ApiException
      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. (asynchronously) Retrieve the session ID from the `/sessions/whoami` endpoint / `toSession` SDK method.
      Parameters:
      id - ID is the session's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      400 jsonError -
      404 jsonError -
      500 jsonError -

    • adminGetIdentityCall

      public okhttp3.Call adminGetIdentityCall​(String id, List<String> includeCredential, ApiCallback _callback) throws ApiException
      Build call for adminGetIdentity
      Parameters:
      id - ID must be set to the ID of identity you want to get (required)
      includeCredential - DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      404 jsonError -
      500 jsonError -

    • adminGetIdentity

      public Identity adminGetIdentity​(String id, List<String> includeCredential) throws ApiException
      Get an Identity Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to get (required)
      includeCredential - DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. (optional)
      Returns:
      Identity
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      404 jsonError -
      500 jsonError -

    • adminGetIdentityWithHttpInfo

      public ApiResponse<Identity> adminGetIdentityWithHttpInfo​(String id, List<String> includeCredential) throws ApiException
      Get an Identity Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to get (required)
      includeCredential - DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. (optional)
      Returns:
      ApiResponse<Identity>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      404 jsonError -
      500 jsonError -

    • adminGetIdentityAsync

      public okhttp3.Call adminGetIdentityAsync​(String id, List<String> includeCredential, ApiCallback<Identity> _callback) throws ApiException
      Get an Identity (asynchronously) Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to get (required)
      includeCredential - DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      404 jsonError -
      500 jsonError -

    • adminListIdentitiesCall

      public okhttp3.Call adminListIdentitiesCall​(Long perPage, Long page, ApiCallback _callback) throws ApiException
      Build call for adminListIdentities
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identityList -
      500 jsonError -

    • adminListIdentities

      public List<Identity> adminListIdentities​(Long perPage, Long page) throws ApiException
      List Identities Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      List<Identity>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identityList -
      500 jsonError -

    • adminListIdentitiesWithHttpInfo

      public ApiResponse<List<Identity>> adminListIdentitiesWithHttpInfo​(Long perPage, Long page) throws ApiException
      List Identities Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      ApiResponse<List<Identity>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identityList -
      500 jsonError -

    • adminListIdentitiesAsync

      public okhttp3.Call adminListIdentitiesAsync​(Long perPage, Long page, ApiCallback<List<Identity>> _callback) throws ApiException
      List Identities (asynchronously) Lists all identities. Does not support search at the moment. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identityList -
      500 jsonError -

    • adminListIdentitySessionsCall

      public okhttp3.Call adminListIdentitySessionsCall​(String id, Long perPage, Long page, Boolean active, ApiCallback _callback) throws ApiException
      Build call for adminListIdentitySessions
      Parameters:
      id - ID is the identity's ID. (required)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      active - Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminListIdentitySessions

      public List<Session> adminListIdentitySessions​(String id, Long perPage, Long page, Boolean active) throws ApiException
      This endpoint returns all sessions that belong to the given Identity. This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
      Parameters:
      id - ID is the identity's ID. (required)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      active - Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. (optional)
      Returns:
      List<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminListIdentitySessionsWithHttpInfo

      public ApiResponse<List<Session>> adminListIdentitySessionsWithHttpInfo​(String id, Long perPage, Long page, Boolean active) throws ApiException
      This endpoint returns all sessions that belong to the given Identity. This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
      Parameters:
      id - ID is the identity's ID. (required)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      active - Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. (optional)
      Returns:
      ApiResponse<List<Session>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminListIdentitySessionsAsync

      public okhttp3.Call adminListIdentitySessionsAsync​(String id, Long perPage, Long page, Boolean active, ApiCallback<List<Session>> _callback) throws ApiException
      This endpoint returns all sessions that belong to the given Identity. (asynchronously) This endpoint is useful for: Listing all sessions that belong to an Identity in an administrative context.
      Parameters:
      id - ID is the identity's ID. (required)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      active - Active is a boolean flag that filters out sessions based on the state. If no value is provided, all sessions are returned. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • adminUpdateIdentityCall

      public okhttp3.Call adminUpdateIdentityCall​(String id, AdminUpdateIdentityBody adminUpdateIdentityBody, ApiCallback _callback) throws ApiException
      Build call for adminUpdateIdentity
      Parameters:
      id - ID must be set to the ID of identity you want to update (required)
      adminUpdateIdentityBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      400 jsonError -
      404 jsonError -
      409 jsonError -
      500 jsonError -

    • adminUpdateIdentity

      public Identity adminUpdateIdentity​(String id, AdminUpdateIdentityBody adminUpdateIdentityBody) throws ApiException
      Update an Identity This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to update (required)
      adminUpdateIdentityBody - (optional)
      Returns:
      Identity
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      400 jsonError -
      404 jsonError -
      409 jsonError -
      500 jsonError -

    • adminUpdateIdentityWithHttpInfo

      public ApiResponse<Identity> adminUpdateIdentityWithHttpInfo​(String id, AdminUpdateIdentityBody adminUpdateIdentityBody) throws ApiException
      Update an Identity This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to update (required)
      adminUpdateIdentityBody - (optional)
      Returns:
      ApiResponse<Identity>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      400 jsonError -
      404 jsonError -
      409 jsonError -
      500 jsonError -

    • adminUpdateIdentityAsync

      public okhttp3.Call adminUpdateIdentityAsync​(String id, AdminUpdateIdentityBody adminUpdateIdentityBody, ApiCallback<Identity> _callback) throws ApiException
      Update an Identity (asynchronously) This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in [Ory Kratos' User And Identity Model Documentation](https://www.ory.sh/docs/next/kratos/concepts/identity-user-model).
      Parameters:
      id - ID must be set to the ID of identity you want to update (required)
      adminUpdateIdentityBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identity -
      400 jsonError -
      404 jsonError -
      409 jsonError -
      500 jsonError -

    • createProjectCall

      public okhttp3.Call createProjectCall​(CreateProjectBody createProjectBody, ApiCallback _callback) throws ApiException
      Build call for createProject
      Parameters:
      createProjectBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • createProject

      public Project createProject​(CreateProjectBody createProjectBody) throws ApiException
      Create a Project Creates a new project.
      Parameters:
      createProjectBody - (optional)
      Returns:
      Project
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • createProjectWithHttpInfo

      public ApiResponse<Project> createProjectWithHttpInfo​(CreateProjectBody createProjectBody) throws ApiException
      Create a Project Creates a new project.
      Parameters:
      createProjectBody - (optional)
      Returns:
      ApiResponse<Project>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      201 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • createProjectAsync

      public okhttp3.Call createProjectAsync​(CreateProjectBody createProjectBody, ApiCallback<Project> _callback) throws ApiException
      Create a Project (asynchronously) Creates a new project.
      Parameters:
      createProjectBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      201 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • createSelfServiceLogoutFlowUrlForBrowsersCall

      public okhttp3.Call createSelfServiceLogoutFlowUrlForBrowsersCall​(String cookie, ApiCallback _callback) throws ApiException
      Build call for createSelfServiceLogoutFlowUrlForBrowsers
      Parameters:
      cookie - HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLogoutUrl -
      401 jsonError -
      500 jsonError -

    • createSelfServiceLogoutFlowUrlForBrowsers

      public SelfServiceLogoutUrl createSelfServiceLogoutFlowUrlForBrowsers​(String cookie) throws ApiException
      Create a Logout URL for Browsers This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
      Parameters:
      cookie - HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. (optional)
      Returns:
      SelfServiceLogoutUrl
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLogoutUrl -
      401 jsonError -
      500 jsonError -

    • createSelfServiceLogoutFlowUrlForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceLogoutUrl> createSelfServiceLogoutFlowUrlForBrowsersWithHttpInfo​(String cookie) throws ApiException
      Create a Logout URL for Browsers This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
      Parameters:
      cookie - HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. (optional)
      Returns:
      ApiResponse<SelfServiceLogoutUrl>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLogoutUrl -
      401 jsonError -
      500 jsonError -

    • createSelfServiceLogoutFlowUrlForBrowsersAsync

      public okhttp3.Call createSelfServiceLogoutFlowUrlForBrowsersAsync​(String cookie, ApiCallback<SelfServiceLogoutUrl> _callback) throws ApiException
      Create a Logout URL for Browsers (asynchronously) This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error. When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
      Parameters:
      cookie - HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLogoutUrl -
      401 jsonError -
      500 jsonError -

    • getJsonSchemaCall

      public okhttp3.Call getJsonSchemaCall​(String id, ApiCallback _callback) throws ApiException
      Build call for getJsonSchema
      Parameters:
      id - ID must be set to the ID of schema you want to get (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 jsonSchema -
      404 jsonError -
      500 jsonError -

    • getJsonSchema

      public Object getJsonSchema​(String id) throws ApiException
      Get a JSON Schema
      Parameters:
      id - ID must be set to the ID of schema you want to get (required)
      Returns:
      Object
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 jsonSchema -
      404 jsonError -
      500 jsonError -

    • getJsonSchemaWithHttpInfo

      public ApiResponse<Object> getJsonSchemaWithHttpInfo​(String id) throws ApiException
      Get a JSON Schema
      Parameters:
      id - ID must be set to the ID of schema you want to get (required)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 jsonSchema -
      404 jsonError -
      500 jsonError -

    • getJsonSchemaAsync

      public okhttp3.Call getJsonSchemaAsync​(String id, ApiCallback<Object> _callback) throws ApiException
      (asynchronously) Get a JSON Schema
      Parameters:
      id - ID must be set to the ID of schema you want to get (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 jsonSchema -
      404 jsonError -
      500 jsonError -

    • getProjectCall

      public okhttp3.Call getProjectCall​(String projectId, ApiCallback _callback) throws ApiException
      Build call for getProject
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • getProject

      public Project getProject​(String projectId) throws ApiException
      Get a Project Get a projects you have access to by its ID.
      Parameters:
      projectId - Project ID The project's ID. (required)
      Returns:
      Project
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • getProjectWithHttpInfo

      public ApiResponse<Project> getProjectWithHttpInfo​(String projectId) throws ApiException
      Get a Project Get a projects you have access to by its ID.
      Parameters:
      projectId - Project ID The project's ID. (required)
      Returns:
      ApiResponse<Project>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • getProjectAsync

      public okhttp3.Call getProjectAsync​(String projectId, ApiCallback<Project> _callback) throws ApiException
      Get a Project (asynchronously) Get a projects you have access to by its ID.
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 project -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • getProjectMembersCall

      public okhttp3.Call getProjectMembersCall​(String projectId, ApiCallback _callback) throws ApiException
      Build call for getProjectMembers
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 projectMembers -
      401 genericError -
      406 genericError -
      500 genericError -

    • getProjectMembers

      public List<CloudAccount> getProjectMembers​(String projectId) throws ApiException
      Get all members associated with this project. This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      Returns:
      List<CloudAccount>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 projectMembers -
      401 genericError -
      406 genericError -
      500 genericError -

    • getProjectMembersWithHttpInfo

      public ApiResponse<List<CloudAccount>> getProjectMembersWithHttpInfo​(String projectId) throws ApiException
      Get all members associated with this project. This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      Returns:
      ApiResponse<List<CloudAccount>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 projectMembers -
      401 genericError -
      406 genericError -
      500 genericError -

    • getProjectMembersAsync

      public okhttp3.Call getProjectMembersAsync​(String projectId, ApiCallback<List<CloudAccount>> _callback) throws ApiException
      Get all members associated with this project. (asynchronously) This endpoint requires the user to be a member of the project with the role `OWNER` or `DEVELOPER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 projectMembers -
      401 genericError -
      406 genericError -
      500 genericError -

    • getSelfServiceErrorCall

      public okhttp3.Call getSelfServiceErrorCall​(String id, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceError
      Parameters:
      id - Error is the error's ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceError -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceError

      public SelfServiceError getSelfServiceError​(String id) throws ApiException
      Get Self-Service Errors This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?id=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
      Parameters:
      id - Error is the error's ID (required)
      Returns:
      SelfServiceError
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceError -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceErrorWithHttpInfo

      public ApiResponse<SelfServiceError> getSelfServiceErrorWithHttpInfo​(String id) throws ApiException
      Get Self-Service Errors This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?id=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
      Parameters:
      id - Error is the error's ID (required)
      Returns:
      ApiResponse<SelfServiceError>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceError -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceErrorAsync

      public okhttp3.Call getSelfServiceErrorAsync​(String id, ApiCallback<SelfServiceError> _callback) throws ApiException
      Get Self-Service Errors (asynchronously) This endpoint returns the error associated with a user-facing self service errors. This endpoint supports stub values to help you implement the error UI: `?id=stub:500` - returns a stub 500 (Internal Server Error) error. More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
      Parameters:
      id - Error is the error's ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceError -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceLoginFlowCall

      public okhttp3.Call getSelfServiceLoginFlowCall​(String id, String cookie, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceLoginFlow
      Parameters:
      id - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceLoginFlow

      public SelfServiceLoginFlow getSelfServiceLoginFlow​(String id, String cookie) throws ApiException
      Get Login Flow This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      SelfServiceLoginFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceLoginFlowWithHttpInfo

      public ApiResponse<SelfServiceLoginFlow> getSelfServiceLoginFlowWithHttpInfo​(String id, String cookie) throws ApiException
      Get Login Flow This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      ApiResponse<SelfServiceLoginFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceLoginFlowAsync

      public okhttp3.Call getSelfServiceLoginFlowAsync​(String id, String cookie, ApiCallback<SelfServiceLoginFlow> _callback) throws ApiException
      Get Login Flow (asynchronously) This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getSelfServiceLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRecoveryFlowCall

      public okhttp3.Call getSelfServiceRecoveryFlowCall​(String id, String cookie, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceRecoveryFlow
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRecoveryFlow

      public SelfServiceRecoveryFlow getSelfServiceRecoveryFlow​(String id, String cookie) throws ApiException
      Get Recovery Flow This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      SelfServiceRecoveryFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRecoveryFlowWithHttpInfo

      public ApiResponse<SelfServiceRecoveryFlow> getSelfServiceRecoveryFlowWithHttpInfo​(String id, String cookie) throws ApiException
      Get Recovery Flow This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      ApiResponse<SelfServiceRecoveryFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRecoveryFlowAsync

      public okhttp3.Call getSelfServiceRecoveryFlowAsync​(String id, String cookie, ApiCallback<SelfServiceRecoveryFlow> _callback) throws ApiException
      Get Recovery Flow (asynchronously) This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRegistrationFlowCall

      public okhttp3.Call getSelfServiceRegistrationFlowCall​(String id, String cookie, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceRegistrationFlow
      Parameters:
      id - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRegistrationFlow

      public SelfServiceRegistrationFlow getSelfServiceRegistrationFlow​(String id, String cookie) throws ApiException
      Get Registration Flow This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      SelfServiceRegistrationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRegistrationFlowWithHttpInfo

      public ApiResponse<SelfServiceRegistrationFlow> getSelfServiceRegistrationFlowWithHttpInfo​(String id, String cookie) throws ApiException
      Get Registration Flow This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      ApiResponse<SelfServiceRegistrationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceRegistrationFlowAsync

      public okhttp3.Call getSelfServiceRegistrationFlowAsync​(String id, String cookie, ApiCallback<SelfServiceRegistrationFlow> _callback) throws ApiException
      Get Registration Flow (asynchronously) This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getSelfServiceRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      id - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceSettingsFlowCall

      public okhttp3.Call getSelfServiceSettingsFlowCall​(String id, String xSessionToken, String cookie, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceSettingsFlow
      Parameters:
      id - ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token When using the SDK in an app without a browser, please include the session token here. (optional)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceSettingsFlow

      public SelfServiceSettingsFlow getSelfServiceSettingsFlow​(String id, String xSessionToken, String cookie) throws ApiException
      Get Settings Flow When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos' Admin API. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      id - ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token When using the SDK in an app without a browser, please include the session token here. (optional)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows. (optional)
      Returns:
      SelfServiceSettingsFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceSettingsFlowWithHttpInfo

      public ApiResponse<SelfServiceSettingsFlow> getSelfServiceSettingsFlowWithHttpInfo​(String id, String xSessionToken, String cookie) throws ApiException
      Get Settings Flow When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos' Admin API. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      id - ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token When using the SDK in an app without a browser, please include the session token here. (optional)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows. (optional)
      Returns:
      ApiResponse<SelfServiceSettingsFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceSettingsFlowAsync

      public okhttp3.Call getSelfServiceSettingsFlowAsync​(String id, String xSessionToken, String cookie, ApiCallback<SelfServiceSettingsFlow> _callback) throws ApiException
      Get Settings Flow (asynchronously) When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. You can access this endpoint without credentials when using Ory Kratos' Admin API. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      id - ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token When using the SDK in an app without a browser, please include the session token here. (optional)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      404 jsonError -
      410 jsonError -
      500 jsonError -

    • getSelfServiceVerificationFlowCall

      public okhttp3.Call getSelfServiceVerificationFlowCall​(String id, String cookie, ApiCallback _callback) throws ApiException
      Build call for getSelfServiceVerificationFlow
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceVerificationFlow

      public SelfServiceVerificationFlow getSelfServiceVerificationFlow​(String id, String cookie) throws ApiException
      Get Verification Flow This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      SelfServiceVerificationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceVerificationFlowWithHttpInfo

      public ApiResponse<SelfServiceVerificationFlow> getSelfServiceVerificationFlowWithHttpInfo​(String id, String cookie) throws ApiException
      Get Verification Flow This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      Returns:
      ApiResponse<SelfServiceVerificationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getSelfServiceVerificationFlowAsync

      public okhttp3.Call getSelfServiceVerificationFlowAsync​(String id, String cookie, ApiCallback<SelfServiceVerificationFlow> _callback) throws ApiException
      Get Verification Flow (asynchronously) This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      id - The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      cookie - HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      403 jsonError -
      404 jsonError -
      500 jsonError -

    • getWebAuthnJavaScriptCall

      public okhttp3.Call getWebAuthnJavaScriptCall​(ApiCallback _callback) throws ApiException
      Build call for getWebAuthnJavaScript
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 webAuthnJavaScript -

    • getWebAuthnJavaScript

      public String getWebAuthnJavaScript() throws ApiException
      Get WebAuthn JavaScript This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Returns:
      String
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 webAuthnJavaScript -

    • getWebAuthnJavaScriptWithHttpInfo

      public ApiResponse<String> getWebAuthnJavaScriptWithHttpInfo() throws ApiException
      Get WebAuthn JavaScript This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Returns:
      ApiResponse<String>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 webAuthnJavaScript -

    • getWebAuthnJavaScriptAsync

      public okhttp3.Call getWebAuthnJavaScriptAsync​(ApiCallback<String> _callback) throws ApiException
      Get WebAuthn JavaScript (asynchronously) This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html <script src=\"https://public-kratos.example.org/.well-known/ory/webauthn.js\" type=\"script\" async /> ``` More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 webAuthnJavaScript -

    • initializeSelfServiceLoginFlowForBrowsersCall

      public okhttp3.Call initializeSelfServiceLoginFlowForBrowsersCall​(Boolean refresh, String aal, String returnTo, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceLoginFlowForBrowsers
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowForBrowsers

      public SelfServiceLoginFlow initializeSelfServiceLoginFlowForBrowsers​(Boolean refresh, String aal, String returnTo) throws ApiException
      Initialize Login Flow for Browsers This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      SelfServiceLoginFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceLoginFlow> initializeSelfServiceLoginFlowForBrowsersWithHttpInfo​(Boolean refresh, String aal, String returnTo) throws ApiException
      Initialize Login Flow for Browsers This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      ApiResponse<SelfServiceLoginFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowForBrowsersAsync

      public okhttp3.Call initializeSelfServiceLoginFlowForBrowsersAsync​(Boolean refresh, String aal, String returnTo, ApiCallback<SelfServiceLoginFlow> _callback) throws ApiException
      Initialize Login Flow for Browsers (asynchronously) This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowWithoutBrowserCall

      public okhttp3.Call initializeSelfServiceLoginFlowWithoutBrowserCall​(Boolean refresh, String aal, String xSessionToken, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceLoginFlowWithoutBrowser
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowWithoutBrowser

      public SelfServiceLoginFlow initializeSelfServiceLoginFlowWithoutBrowser​(Boolean refresh, String aal, String xSessionToken) throws ApiException
      Initialize Login Flow for APIs, Services, Apps, ... This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      Returns:
      SelfServiceLoginFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowWithoutBrowserWithHttpInfo

      public ApiResponse<SelfServiceLoginFlow> initializeSelfServiceLoginFlowWithoutBrowserWithHttpInfo​(Boolean refresh, String aal, String xSessionToken) throws ApiException
      Initialize Login Flow for APIs, Services, Apps, ... This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      Returns:
      ApiResponse<SelfServiceLoginFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceLoginFlowWithoutBrowserAsync

      public okhttp3.Call initializeSelfServiceLoginFlowWithoutBrowserAsync​(Boolean refresh, String aal, String xSessionToken, ApiCallback<SelfServiceLoginFlow> _callback) throws ApiException
      Initialize Login Flow for APIs, Services, Apps, ... (asynchronously) This endpoint initiates a login flow for API clients that do not use a browser, such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing login flow call `/self-service/login/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks, including CSRF login attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      refresh - Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session. (optional)
      aal - Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". (optional)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceLoginFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowForBrowsersCall

      public okhttp3.Call initializeSelfServiceRecoveryFlowForBrowsersCall​(String returnTo, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceRecoveryFlowForBrowsers
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowForBrowsers

      public SelfServiceRecoveryFlow initializeSelfServiceRecoveryFlowForBrowsers​(String returnTo) throws ApiException
      Initialize Recovery Flow for Browsers This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      SelfServiceRecoveryFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceRecoveryFlow> initializeSelfServiceRecoveryFlowForBrowsersWithHttpInfo​(String returnTo) throws ApiException
      Initialize Recovery Flow for Browsers This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      ApiResponse<SelfServiceRecoveryFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowForBrowsersAsync

      public okhttp3.Call initializeSelfServiceRecoveryFlowForBrowsersAsync​(String returnTo, ApiCallback<SelfServiceRecoveryFlow> _callback) throws ApiException
      Initialize Recovery Flow for Browsers (asynchronously) This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowWithoutBrowserCall

      public okhttp3.Call initializeSelfServiceRecoveryFlowWithoutBrowserCall​(ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceRecoveryFlowWithoutBrowser
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowWithoutBrowser

      public SelfServiceRecoveryFlow initializeSelfServiceRecoveryFlowWithoutBrowser() throws ApiException
      Initialize Recovery Flow for APIs, Services, Apps, ... This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Returns:
      SelfServiceRecoveryFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowWithoutBrowserWithHttpInfo

      public ApiResponse<SelfServiceRecoveryFlow> initializeSelfServiceRecoveryFlowWithoutBrowserWithHttpInfo() throws ApiException
      Initialize Recovery Flow for APIs, Services, Apps, ... This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Returns:
      ApiResponse<SelfServiceRecoveryFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRecoveryFlowWithoutBrowserAsync

      public okhttp3.Call initializeSelfServiceRecoveryFlowWithoutBrowserAsync​(ApiCallback<SelfServiceRecoveryFlow> _callback) throws ApiException
      Initialize Recovery Flow for APIs, Services, Apps, ... (asynchronously) This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error. To fetch an existing recovery flow call `/self-service/recovery/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowForBrowsersCall

      public okhttp3.Call initializeSelfServiceRegistrationFlowForBrowsersCall​(String returnTo, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceRegistrationFlowForBrowsers
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowForBrowsers

      public SelfServiceRegistrationFlow initializeSelfServiceRegistrationFlowForBrowsers​(String returnTo) throws ApiException
      Initialize Registration Flow for Browsers This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      SelfServiceRegistrationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceRegistrationFlow> initializeSelfServiceRegistrationFlowForBrowsersWithHttpInfo​(String returnTo) throws ApiException
      Initialize Registration Flow for Browsers This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      ApiResponse<SelfServiceRegistrationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowForBrowsersAsync

      public okhttp3.Call initializeSelfServiceRegistrationFlowForBrowsersAsync​(String returnTo, ApiCallback<SelfServiceRegistrationFlow> _callback) throws ApiException
      Initialize Registration Flow for Browsers (asynchronously) This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowWithoutBrowserCall

      public okhttp3.Call initializeSelfServiceRegistrationFlowWithoutBrowserCall​(ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceRegistrationFlowWithoutBrowser
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowWithoutBrowser

      public SelfServiceRegistrationFlow initializeSelfServiceRegistrationFlowWithoutBrowser() throws ApiException
      Initialize Registration Flow for APIs, Services, Apps, ... This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Returns:
      SelfServiceRegistrationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowWithoutBrowserWithHttpInfo

      public ApiResponse<SelfServiceRegistrationFlow> initializeSelfServiceRegistrationFlowWithoutBrowserWithHttpInfo() throws ApiException
      Initialize Registration Flow for APIs, Services, Apps, ... This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Returns:
      ApiResponse<SelfServiceRegistrationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceRegistrationFlowWithoutBrowserAsync

      public okhttp3.Call initializeSelfServiceRegistrationFlowWithoutBrowserAsync​(ApiCallback<SelfServiceRegistrationFlow> _callback) throws ApiException
      Initialize Registration Flow for APIs, Services, Apps, ... (asynchronously) This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on. If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set. To fetch an existing registration flow call `/self-service/registration/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRegistrationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowForBrowsersCall

      public okhttp3.Call initializeSelfServiceSettingsFlowForBrowsersCall​(String returnTo, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceSettingsFlowForBrowsers
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowForBrowsers

      public SelfServiceSettingsFlow initializeSelfServiceSettingsFlowForBrowsers​(String returnTo) throws ApiException
      Initialize Settings Flow for Browsers This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      SelfServiceSettingsFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceSettingsFlow> initializeSelfServiceSettingsFlowForBrowsersWithHttpInfo​(String returnTo) throws ApiException
      Initialize Settings Flow for Browsers This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      ApiResponse<SelfServiceSettingsFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowForBrowsersAsync

      public okhttp3.Call initializeSelfServiceSettingsFlowForBrowsersAsync​(String returnTo, ApiCallback<SelfServiceSettingsFlow> _callback) throws ApiException
      Initialize Settings Flow for Browsers (asynchronously) This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint. If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowWithoutBrowserCall

      public okhttp3.Call initializeSelfServiceSettingsFlowWithoutBrowserCall​(String xSessionToken, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceSettingsFlowWithoutBrowser
      Parameters:
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowWithoutBrowser

      public SelfServiceSettingsFlow initializeSelfServiceSettingsFlowWithoutBrowser​(String xSessionToken) throws ApiException
      Initialize Settings Flow for APIs, Services, Apps, ... This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      Returns:
      SelfServiceSettingsFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowWithoutBrowserWithHttpInfo

      public ApiResponse<SelfServiceSettingsFlow> initializeSelfServiceSettingsFlowWithoutBrowserWithHttpInfo​(String xSessionToken) throws ApiException
      Initialize Settings Flow for APIs, Services, Apps, ... This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      Returns:
      ApiResponse<SelfServiceSettingsFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceSettingsFlowWithoutBrowserAsync

      public okhttp3.Call initializeSelfServiceSettingsFlowWithoutBrowserAsync​(String xSessionToken, ApiCallback<SelfServiceSettingsFlow> _callback) throws ApiException
      Initialize Settings Flow for APIs, Services, Apps, ... (asynchronously) This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK. To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. In the case of an error, the `error.id` of the JSON response body can be one of: `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceVerificationFlowForBrowsersCall

      public okhttp3.Call initializeSelfServiceVerificationFlowForBrowsersCall​(String returnTo, ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceVerificationFlowForBrowsers
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceVerificationFlowForBrowsers

      public SelfServiceVerificationFlow initializeSelfServiceVerificationFlowForBrowsers​(String returnTo) throws ApiException
      Initialize Verification Flow for Browser Clients This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      SelfServiceVerificationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceVerificationFlowForBrowsersWithHttpInfo

      public ApiResponse<SelfServiceVerificationFlow> initializeSelfServiceVerificationFlowForBrowsersWithHttpInfo​(String returnTo) throws ApiException
      Initialize Verification Flow for Browser Clients This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      Returns:
      ApiResponse<SelfServiceVerificationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceVerificationFlowForBrowsersAsync

      public okhttp3.Call initializeSelfServiceVerificationFlowForBrowsersAsync​(String returnTo, ApiCallback<SelfServiceVerificationFlow> _callback) throws ApiException
      Initialize Verification Flow for Browser Clients (asynchronously) This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      returnTo - The URL to return the browser to after the flow was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • initializeSelfServiceVerificationFlowWithoutBrowserCall

      public okhttp3.Call initializeSelfServiceVerificationFlowWithoutBrowserCall​(ApiCallback _callback) throws ApiException
      Build call for initializeSelfServiceVerificationFlowWithoutBrowser
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceVerificationFlowWithoutBrowser

      public SelfServiceVerificationFlow initializeSelfServiceVerificationFlowWithoutBrowser() throws ApiException
      Initialize Verification Flow for APIs, Services, Apps, ... This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Returns:
      SelfServiceVerificationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceVerificationFlowWithoutBrowserWithHttpInfo

      public ApiResponse<SelfServiceVerificationFlow> initializeSelfServiceVerificationFlowWithoutBrowserWithHttpInfo() throws ApiException
      Initialize Verification Flow for APIs, Services, Apps, ... This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Returns:
      ApiResponse<SelfServiceVerificationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      400 jsonError -
      500 jsonError -

    • initializeSelfServiceVerificationFlowWithoutBrowserAsync

      public okhttp3.Call initializeSelfServiceVerificationFlowWithoutBrowserAsync​(ApiCallback<SelfServiceVerificationFlow> _callback) throws ApiException
      Initialize Verification Flow for APIs, Services, Apps, ... (asynchronously) This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=<flow_id>`. You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks. This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      400 jsonError -
      500 jsonError -

    • listIdentitySchemasCall

      public okhttp3.Call listIdentitySchemasCall​(Long perPage, Long page, ApiCallback _callback) throws ApiException
      Build call for listIdentitySchemas
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identitySchemas -
      500 jsonError -

    • listIdentitySchemas

      public List<IdentitySchema> listIdentitySchemas​(Long perPage, Long page) throws ApiException
      Get all Identity Schemas
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      List<IdentitySchema>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identitySchemas -
      500 jsonError -

    • listIdentitySchemasWithHttpInfo

      public ApiResponse<List<IdentitySchema>> listIdentitySchemasWithHttpInfo​(Long perPage, Long page) throws ApiException
      Get all Identity Schemas
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      ApiResponse<List<IdentitySchema>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 identitySchemas -
      500 jsonError -

    • listIdentitySchemasAsync

      public okhttp3.Call listIdentitySchemasAsync​(Long perPage, Long page, ApiCallback<List<IdentitySchema>> _callback) throws ApiException
      (asynchronously) Get all Identity Schemas
      Parameters:
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 identitySchemas -
      500 jsonError -

    • listProjectsCall

      public okhttp3.Call listProjectsCall​(ApiCallback _callback) throws ApiException
      Build call for listProjects
      Parameters:
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 projectMetadataList -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • listProjects

      public List<ProjectMetadata> listProjects() throws ApiException
      List All Projects Lists all projects you have access to.
      Returns:
      List<ProjectMetadata>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 projectMetadataList -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • listProjectsWithHttpInfo

      public ApiResponse<List<ProjectMetadata>> listProjectsWithHttpInfo() throws ApiException
      List All Projects Lists all projects you have access to.
      Returns:
      ApiResponse<List<ProjectMetadata>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 projectMetadataList -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • listProjectsAsync

      public okhttp3.Call listProjectsAsync​(ApiCallback<List<ProjectMetadata>> _callback) throws ApiException
      List All Projects (asynchronously) Lists all projects you have access to.
      Parameters:
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 projectMetadataList -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • listSessionsCall

      public okhttp3.Call listSessionsCall​(String xSessionToken, String cookie, Long perPage, Long page, ApiCallback _callback) throws ApiException
      Build call for listSessions
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • listSessions

      public List<Session> listSessions​(String xSessionToken, String cookie, Long perPage, Long page) throws ApiException
      This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint. This endpoint is useful for: Displaying all other sessions that belong to the logged-in user
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      List<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • listSessionsWithHttpInfo

      public ApiResponse<List<Session>> listSessionsWithHttpInfo​(String xSessionToken, String cookie, Long perPage, Long page) throws ApiException
      This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint. This endpoint is useful for: Displaying all other sessions that belong to the logged-in user
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      Returns:
      ApiResponse<List<Session>>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • listSessionsAsync

      public okhttp3.Call listSessionsAsync​(String xSessionToken, String cookie, Long perPage, Long page, ApiCallback<List<Session>> _callback) throws ApiException
      This endpoints returns all other active sessions that belong to the logged-in user. The current session can be retrieved by calling the `/sessions/whoami` endpoint. (asynchronously) This endpoint is useful for: Displaying all other sessions that belong to the logged-in user
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      perPage - Items per Page This is the number of items per page. (optional, default to 250)
      page - Pagination Page (optional, default to 1)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 sessionList -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • patchProjectCall

      public okhttp3.Call patchProjectCall​(String projectId, List<JsonPatch> jsonPatch, ApiCallback _callback) throws ApiException
      Build call for patchProject
      Parameters:
      projectId - Project ID The project's ID. (required)
      jsonPatch - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • patchProject

      public SuccessfulProjectUpdate patchProject​(String projectId, List<JsonPatch> jsonPatch) throws ApiException
      Patch an Ory Cloud Project Configuration This endpoints allows you to patch individual Ory Cloud Project configuration keys for Ory's services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
      Parameters:
      projectId - Project ID The project's ID. (required)
      jsonPatch - (optional)
      Returns:
      SuccessfulProjectUpdate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • patchProjectWithHttpInfo

      public ApiResponse<SuccessfulProjectUpdate> patchProjectWithHttpInfo​(String projectId, List<JsonPatch> jsonPatch) throws ApiException
      Patch an Ory Cloud Project Configuration This endpoints allows you to patch individual Ory Cloud Project configuration keys for Ory's services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
      Parameters:
      projectId - Project ID The project's ID. (required)
      jsonPatch - (optional)
      Returns:
      ApiResponse<SuccessfulProjectUpdate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • patchProjectAsync

      public okhttp3.Call patchProjectAsync​(String projectId, List<JsonPatch> jsonPatch, ApiCallback<SuccessfulProjectUpdate> _callback) throws ApiException
      Patch an Ory Cloud Project Configuration (asynchronously) This endpoints allows you to patch individual Ory Cloud Project configuration keys for Ory's services (identity, permission, ...). The configuration format is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.
      Parameters:
      projectId - Project ID The project's ID. (required)
      jsonPatch - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • purgeProjectCall

      public okhttp3.Call purgeProjectCall​(String projectId, ApiCallback _callback) throws ApiException
      Build call for purgeProject
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • purgeProject

      public void purgeProject​(String projectId) throws ApiException
      Irrecoverably Purge a Project !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. !! Use with extreme caution !!
      Parameters:
      projectId - Project ID The project's ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • purgeProjectWithHttpInfo

      public ApiResponse<Void> purgeProjectWithHttpInfo​(String projectId) throws ApiException
      Irrecoverably Purge a Project !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. !! Use with extreme caution !!
      Parameters:
      projectId - Project ID The project's ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • purgeProjectAsync

      public okhttp3.Call purgeProjectAsync​(String projectId, ApiCallback<Void> _callback) throws ApiException
      Irrecoverably Purge a Project (asynchronously) !! Use with extreme caution !! Using this API endpoint you can purge (completely delete) a project and its data. This action can not be undone and will delete ALL your data. !! Use with extreme caution !!
      Parameters:
      projectId - Project ID The project's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • removeProjectMemberCall

      public okhttp3.Call removeProjectMemberCall​(String projectId, String memberId, ApiCallback _callback) throws ApiException
      Build call for removeProjectMember
      Parameters:
      projectId - Project ID The project's ID. (required)
      memberId - Member ID (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 genericError -
      401 genericError -
      406 genericError -
      500 genericError -

    • removeProjectMember

      public void removeProjectMember​(String projectId, String memberId) throws ApiException
      Remove a member associated with this project. This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      memberId - Member ID (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 genericError -
      401 genericError -
      406 genericError -
      500 genericError -

    • removeProjectMemberWithHttpInfo

      public ApiResponse<Void> removeProjectMemberWithHttpInfo​(String projectId, String memberId) throws ApiException
      Remove a member associated with this project. This also sets their invite status to `REMOVED`. This endpoint requires the user to be a member of the project with the role `OWNER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      memberId - Member ID (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 genericError -
      401 genericError -
      406 genericError -
      500 genericError -

    • removeProjectMemberAsync

      public okhttp3.Call removeProjectMemberAsync​(String projectId, String memberId, ApiCallback<Void> _callback) throws ApiException
      Remove a member associated with this project. This also sets their invite status to `REMOVED`. (asynchronously) This endpoint requires the user to be a member of the project with the role `OWNER`.
      Parameters:
      projectId - Project ID The project's ID. (required)
      memberId - Member ID (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 genericError -
      401 genericError -
      406 genericError -
      500 genericError -

    • revokeSessionCall

      public okhttp3.Call revokeSessionCall​(String id, ApiCallback _callback) throws ApiException
      Build call for revokeSession
      Parameters:
      id - ID is the session's ID. (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      500 jsonError -

    • revokeSession

      public void revokeSession​(String id) throws ApiException
      Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. This endpoint is useful for: To forcefully logout the current user from another device or session
      Parameters:
      id - ID is the session's ID. (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      500 jsonError -

    • revokeSessionWithHttpInfo

      public ApiResponse<Void> revokeSessionWithHttpInfo​(String id) throws ApiException
      Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. This endpoint is useful for: To forcefully logout the current user from another device or session
      Parameters:
      id - ID is the session's ID. (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      500 jsonError -

    • revokeSessionAsync

      public okhttp3.Call revokeSessionAsync​(String id, ApiCallback<Void> _callback) throws ApiException
      Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. (asynchronously) This endpoint is useful for: To forcefully logout the current user from another device or session
      Parameters:
      id - ID is the session's ID. (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      401 jsonError -
      500 jsonError -

    • revokeSessionsCall

      public okhttp3.Call revokeSessionsCall​(String xSessionToken, String cookie, ApiCallback _callback) throws ApiException
      Build call for revokeSessions
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 revokedSessions -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • revokeSessions

      public RevokedSessions revokeSessions​(String xSessionToken, String cookie) throws ApiException
      Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. This endpoint is useful for: To forcefully logout the current user from all other devices and sessions
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      Returns:
      RevokedSessions
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 revokedSessions -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • revokeSessionsWithHttpInfo

      public ApiResponse<RevokedSessions> revokeSessionsWithHttpInfo​(String xSessionToken, String cookie) throws ApiException
      Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. This endpoint is useful for: To forcefully logout the current user from all other devices and sessions
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      Returns:
      ApiResponse<RevokedSessions>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 revokedSessions -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • revokeSessionsAsync

      public okhttp3.Call revokeSessionsAsync​(String xSessionToken, String cookie, ApiCallback<RevokedSessions> _callback) throws ApiException
      Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. (asynchronously) This endpoint is useful for: To forcefully logout the current user from all other devices and sessions
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 revokedSessions -
      400 jsonError -
      401 jsonError -
      404 jsonError -
      500 jsonError -

    • submitSelfServiceLoginFlowCall

      public okhttp3.Call submitSelfServiceLoginFlowCall​(String flow, String xSessionToken, SubmitSelfServiceLoginFlowBody submitSelfServiceLoginFlowBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceLoginFlow
      Parameters:
      flow - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceLoginFlowBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceLoginWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceLoginFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceLoginFlow

      public SuccessfulSelfServiceLoginWithoutBrowser submitSelfServiceLoginFlow​(String flow, String xSessionToken, SubmitSelfServiceLoginFlowBody submitSelfServiceLoginFlowBody) throws ApiException
      Submit a Login Flow :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceLoginFlowBody - (optional)
      Returns:
      SuccessfulSelfServiceLoginWithoutBrowser
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceLoginWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceLoginFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceLoginFlowWithHttpInfo

      public ApiResponse<SuccessfulSelfServiceLoginWithoutBrowser> submitSelfServiceLoginFlowWithHttpInfo​(String flow, String xSessionToken, SubmitSelfServiceLoginFlowBody submitSelfServiceLoginFlowBody) throws ApiException
      Submit a Login Flow :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceLoginFlowBody - (optional)
      Returns:
      ApiResponse<SuccessfulSelfServiceLoginWithoutBrowser>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceLoginWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceLoginFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceLoginFlowAsync

      public okhttp3.Call submitSelfServiceLoginFlowAsync​(String flow, String xSessionToken, SubmitSelfServiceLoginFlowBody submitSelfServiceLoginFlowBody, ApiCallback<SuccessfulSelfServiceLoginWithoutBrowser> _callback) throws ApiException
      Submit a Login Flow (asynchronously) :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: Use this endpoint to complete a login flow. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and responds with HTTP 200 and a application/json body with the session token on success; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded; a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceLoginFlowBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceLoginWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceLoginFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceLogoutFlowCall

      public okhttp3.Call submitSelfServiceLogoutFlowCall​(String token, String returnTo, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceLogoutFlow
      Parameters:
      token - A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint. (optional)
      returnTo - The URL to return to after the logout was completed. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • submitSelfServiceLogoutFlow

      public void submitSelfServiceLogoutFlow​(String token, String returnTo) throws ApiException
      Complete Self-Service Logout This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
      Parameters:
      token - A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint. (optional)
      returnTo - The URL to return to after the logout was completed. (optional)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • submitSelfServiceLogoutFlowWithHttpInfo

      public ApiResponse<Void> submitSelfServiceLogoutFlowWithHttpInfo​(String token, String returnTo) throws ApiException
      Complete Self-Service Logout This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
      Parameters:
      token - A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint. (optional)
      returnTo - The URL to return to after the logout was completed. (optional)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • submitSelfServiceLogoutFlowAsync

      public okhttp3.Call submitSelfServiceLogoutFlowAsync​(String token, String returnTo, ApiCallback<Void> _callback) throws ApiException
      Complete Self-Service Logout (asynchronously) This endpoint logs out an identity in a self-service manner. If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other) to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`. If the `Accept` HTTP header is set to `application/json`, a 204 No Content response will be sent on successful logout instead. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token. More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
      Parameters:
      token - A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint. (optional)
      returnTo - The URL to return to after the logout was completed. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      500 jsonError -

    • submitSelfServiceLogoutFlowWithoutBrowserCall

      public okhttp3.Call submitSelfServiceLogoutFlowWithoutBrowserCall​(SubmitSelfServiceLogoutFlowWithoutBrowserBody submitSelfServiceLogoutFlowWithoutBrowserBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceLogoutFlowWithoutBrowser
      Parameters:
      submitSelfServiceLogoutFlowWithoutBrowserBody - (required)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • submitSelfServiceLogoutFlowWithoutBrowser

      public void submitSelfServiceLogoutFlowWithoutBrowser​(SubmitSelfServiceLogoutFlowWithoutBrowserBody submitSelfServiceLogoutFlowWithoutBrowserBody) throws ApiException
      Perform Logout for APIs, Services, Apps, ... Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when the Ory Session Token has been revoked already before. If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
      Parameters:
      submitSelfServiceLogoutFlowWithoutBrowserBody - (required)
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • submitSelfServiceLogoutFlowWithoutBrowserWithHttpInfo

      public ApiResponse<Void> submitSelfServiceLogoutFlowWithoutBrowserWithHttpInfo​(SubmitSelfServiceLogoutFlowWithoutBrowserBody submitSelfServiceLogoutFlowWithoutBrowserBody) throws ApiException
      Perform Logout for APIs, Services, Apps, ... Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when the Ory Session Token has been revoked already before. If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
      Parameters:
      submitSelfServiceLogoutFlowWithoutBrowserBody - (required)
      Returns:
      ApiResponse<Void>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • submitSelfServiceLogoutFlowWithoutBrowserAsync

      public okhttp3.Call submitSelfServiceLogoutFlowWithoutBrowserAsync​(SubmitSelfServiceLogoutFlowWithoutBrowserBody submitSelfServiceLogoutFlowWithoutBrowserBody, ApiCallback<Void> _callback) throws ApiException
      Perform Logout for APIs, Services, Apps, ... (asynchronously) Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when the Ory Session Token has been revoked already before. If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned. This endpoint does not remove any HTTP Cookies - use the Browser-Based Self-Service Logout Flow instead.
      Parameters:
      submitSelfServiceLogoutFlowWithoutBrowserBody - (required)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      204 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 jsonError -
      500 jsonError -

    • submitSelfServiceRecoveryFlowCall

      public okhttp3.Call submitSelfServiceRecoveryFlowCall​(String flow, String token, SubmitSelfServiceRecoveryFlowBody submitSelfServiceRecoveryFlowBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceRecoveryFlow
      Parameters:
      flow - The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      token - Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceRecoveryFlowBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRecoveryFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceRecoveryFlow

      public SelfServiceRecoveryFlow submitSelfServiceRecoveryFlow​(String flow, String token, SubmitSelfServiceRecoveryFlowBody submitSelfServiceRecoveryFlowBody) throws ApiException
      Complete Recovery Flow Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      flow - The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      token - Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceRecoveryFlowBody - (optional)
      Returns:
      SelfServiceRecoveryFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRecoveryFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceRecoveryFlowWithHttpInfo

      public ApiResponse<SelfServiceRecoveryFlow> submitSelfServiceRecoveryFlowWithHttpInfo​(String flow, String token, SubmitSelfServiceRecoveryFlowBody submitSelfServiceRecoveryFlowBody) throws ApiException
      Complete Recovery Flow Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      flow - The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      token - Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceRecoveryFlowBody - (optional)
      Returns:
      ApiResponse<SelfServiceRecoveryFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRecoveryFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceRecoveryFlowAsync

      public okhttp3.Call submitSelfServiceRecoveryFlowAsync​(String flow, String token, SubmitSelfServiceRecoveryFlowBody submitSelfServiceRecoveryFlowBody, ApiCallback<SelfServiceRecoveryFlow> _callback) throws ApiException
      Complete Recovery Flow (asynchronously) Use this endpoint to complete a recovery flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid. and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended. `sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a recovery link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with a new Recovery Flow ID which contains an error message that the recovery link was invalid. More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
      Parameters:
      flow - The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). (required)
      token - Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceRecoveryFlowBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceRecoveryFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRecoveryFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceRegistrationFlowCall

      public okhttp3.Call submitSelfServiceRegistrationFlowCall​(String flow, SubmitSelfServiceRegistrationFlowBody submitSelfServiceRegistrationFlowBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceRegistrationFlow
      Parameters:
      flow - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      submitSelfServiceRegistrationFlowBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceRegistrationWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRegistrationFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceRegistrationFlow

      public SuccessfulSelfServiceRegistrationWithoutBrowser submitSelfServiceRegistrationFlow​(String flow, SubmitSelfServiceRegistrationFlowBody submitSelfServiceRegistrationFlowBody) throws ApiException
      Submit a Registration Flow Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      submitSelfServiceRegistrationFlowBody - (optional)
      Returns:
      SuccessfulSelfServiceRegistrationWithoutBrowser
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceRegistrationWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRegistrationFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceRegistrationFlowWithHttpInfo

      public ApiResponse<SuccessfulSelfServiceRegistrationWithoutBrowser> submitSelfServiceRegistrationFlowWithHttpInfo​(String flow, SubmitSelfServiceRegistrationFlowBody submitSelfServiceRegistrationFlowBody) throws ApiException
      Submit a Registration Flow Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      submitSelfServiceRegistrationFlowBody - (optional)
      Returns:
      ApiResponse<SuccessfulSelfServiceRegistrationWithoutBrowser>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceRegistrationWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRegistrationFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceRegistrationFlowAsync

      public okhttp3.Call submitSelfServiceRegistrationFlowAsync​(String flow, SubmitSelfServiceRegistrationFlowBody submitSelfServiceRegistrationFlowBody, ApiCallback<SuccessfulSelfServiceRegistrationWithoutBrowser> _callback) throws ApiException
      Submit a Registration Flow (asynchronously) Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint behaves differently for API and browser flows. API flows expect `application/json` to be sent in the body and respond with HTTP 200 and a application/json body with the created identity success - if the session hook is configured the `session` and `session_token` will also be included; HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body; HTTP 400 on form validation errors. Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded; a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise. Browser flows with an accept header of `application/json` will not redirect but instead respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
      Parameters:
      flow - The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). (required)
      submitSelfServiceRegistrationFlowBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulSelfServiceRegistrationWithoutBrowser -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceRegistrationFlow -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceSettingsFlowCall

      public okhttp3.Call submitSelfServiceSettingsFlowCall​(String flow, String xSessionToken, SubmitSelfServiceSettingsFlowBody submitSelfServiceSettingsFlowBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceSettingsFlow
      Parameters:
      flow - The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceSettingsFlowBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceSettingsFlow

      public SelfServiceSettingsFlow submitSelfServiceSettingsFlow​(String flow, String xSessionToken, SubmitSelfServiceSettingsFlowBody submitSelfServiceSettingsFlowBody) throws ApiException
      Complete Settings Flow Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/_*` respond with a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      flow - The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceSettingsFlowBody - (optional)
      Returns:
      SelfServiceSettingsFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceSettingsFlowWithHttpInfo

      public ApiResponse<SelfServiceSettingsFlow> submitSelfServiceSettingsFlowWithHttpInfo​(String flow, String xSessionToken, SubmitSelfServiceSettingsFlowBody submitSelfServiceSettingsFlowBody) throws ApiException
      Complete Settings Flow Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/_*` respond with a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      flow - The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceSettingsFlowBody - (optional)
      Returns:
      ApiResponse<SelfServiceSettingsFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceSettingsFlowAsync

      public okhttp3.Call submitSelfServiceSettingsFlowAsync​(String flow, String xSessionToken, SubmitSelfServiceSettingsFlowBody submitSelfServiceSettingsFlowBody, ApiCallback<SelfServiceSettingsFlow> _callback) throws ApiException
      Complete Settings Flow (asynchronously) Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows. API-initiated flows expect `application/json` to be sent in the body and respond with HTTP 200 and an application/json body with the session token on success; HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; HTTP 400 on form validation errors. HTTP 401 when the endpoint is called without a valid session token. HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate. Browser flows without HTTP Header `Accept` or with `Accept: text/_*` respond with a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Browser flows with HTTP Header `Accept: application/json` respond with HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; HTTP 401 when the endpoint is called without a valid session cookie. HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. HTTP 400 on form validation errors. Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration. If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of: `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `session_inactive`: No Ory Session was found - sign in a user first. `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows. More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
      Parameters:
      flow - The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). (required)
      xSessionToken - The Session Token of the Identity performing the settings flow. (optional)
      submitSelfServiceSettingsFlowBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceSettingsFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceSettingsFlow -
      401 jsonError -
      403 jsonError -
      410 jsonError -
      422 selfServiceBrowserLocationChangeRequiredError -
      500 jsonError -

    • submitSelfServiceVerificationFlowCall

      public okhttp3.Call submitSelfServiceVerificationFlowCall​(String flow, String token, SubmitSelfServiceVerificationFlowBody submitSelfServiceVerificationFlowBody, ApiCallback _callback) throws ApiException
      Build call for submitSelfServiceVerificationFlow
      Parameters:
      flow - The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      token - Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceVerificationFlowBody - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceVerificationFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceVerificationFlow

      public SelfServiceVerificationFlow submitSelfServiceVerificationFlow​(String flow, String token, SubmitSelfServiceVerificationFlowBody submitSelfServiceVerificationFlowBody) throws ApiException
      Complete Verification Flow Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      flow - The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      token - Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceVerificationFlowBody - (optional)
      Returns:
      SelfServiceVerificationFlow
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceVerificationFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceVerificationFlowWithHttpInfo

      public ApiResponse<SelfServiceVerificationFlow> submitSelfServiceVerificationFlowWithHttpInfo​(String flow, String token, SubmitSelfServiceVerificationFlowBody submitSelfServiceVerificationFlowBody) throws ApiException
      Complete Verification Flow Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      flow - The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      token - Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceVerificationFlowBody - (optional)
      Returns:
      ApiResponse<SelfServiceVerificationFlow>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceVerificationFlow -
      410 jsonError -
      500 jsonError -

    • submitSelfServiceVerificationFlowAsync

      public okhttp3.Call submitSelfServiceVerificationFlowAsync​(String flow, String token, SubmitSelfServiceVerificationFlowBody submitSelfServiceVerificationFlowBody, ApiCallback<SelfServiceVerificationFlow> _callback) throws ApiException
      Complete Verification Flow (asynchronously) Use this endpoint to complete a verification flow. This endpoint behaves differently for API and browser flows and has several states: `choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent and works with API- and Browser-initiated flows. For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired). For Browser clients without HTTP Header `Accept` or with `Accept: text/_*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended. `sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state. `passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow (\"sending a verification link\") does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL (if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with a new Verification Flow ID which contains an error message that the verification link was invalid. More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/selfservice/flows/verify-email-account-activation).
      Parameters:
      flow - The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). (required)
      token - Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call. (optional)
      submitSelfServiceVerificationFlowBody - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 selfServiceVerificationFlow -
      303 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
      400 selfServiceVerificationFlow -
      410 jsonError -
      500 jsonError -

    • toSessionCall

      public okhttp3.Call toSessionCall​(String xSessionToken, String cookie, ApiCallback _callback) throws ApiException
      Build call for toSession
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • toSession

      public Session toSession​(String xSessionToken, String cookie) throws ApiException
      Check Who the Current HTTP Session Belongs To Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The `error.id` can be one of: `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      Returns:
      Session
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • toSessionWithHttpInfo

      public ApiResponse<Session> toSessionWithHttpInfo​(String xSessionToken, String cookie) throws ApiException
      Check Who the Current HTTP Session Belongs To Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The `error.id` can be one of: `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      Returns:
      ApiResponse<Session>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • toSessionAsync

      public okhttp3.Call toSessionAsync​(String xSessionToken, String cookie, ApiCallback<Session> _callback) throws ApiException
      Check Who the Current HTTP Session Belongs To (asynchronously) Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. Additionally when the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint: ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie')) console.log(session) }) ``` When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token: ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\") console.log(session) ``` Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration. This endpoint is useful for: AJAX calls. Remember to send credentials and set up CORS correctly! Reverse proxies and API Gateways Server-side calls - use the `X-Session-Token` header! This endpoint authenticates users by checking if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token. If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code. As explained above, this request may fail due to several reasons. The `error.id` can be one of: `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
      Parameters:
      xSessionToken - Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. (optional)
      cookie - Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 session -
      401 jsonError -
      403 jsonError -
      500 jsonError -

    • updateProjectCall

      public okhttp3.Call updateProjectCall​(String projectId, UpdateProject updateProject, ApiCallback _callback) throws ApiException
      Build call for updateProject
      Parameters:
      projectId - Project ID The project's ID. (required)
      updateProject - (optional)
      _callback - Callback for upload/download progress
      Returns:
      Call to execute
      Throws:
      ApiException - If fail to serialize the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • updateProject

      public SuccessfulProjectUpdate updateProject​(String projectId, UpdateProject updateProject) throws ApiException
      Update an Ory Cloud Project Configuration This endpoints allows you to update the Ory Cloud Project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service's configuration will completely override your current configuration for that service!
      Parameters:
      projectId - Project ID The project's ID. (required)
      updateProject - (optional)
      Returns:
      SuccessfulProjectUpdate
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • updateProjectWithHttpInfo

      public ApiResponse<SuccessfulProjectUpdate> updateProjectWithHttpInfo​(String projectId, UpdateProject updateProject) throws ApiException
      Update an Ory Cloud Project Configuration This endpoints allows you to update the Ory Cloud Project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service's configuration will completely override your current configuration for that service!
      Parameters:
      projectId - Project ID The project's ID. (required)
      updateProject - (optional)
      Returns:
      ApiResponse<SuccessfulProjectUpdate>
      Throws:
      ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -

    • updateProjectAsync

      public okhttp3.Call updateProjectAsync​(String projectId, UpdateProject updateProject, ApiCallback<SuccessfulProjectUpdate> _callback) throws ApiException
      Update an Ory Cloud Project Configuration (asynchronously) This endpoints allows you to update the Ory Cloud Project configuration for individual services (identity, permission, ...). The configuration is fully compatible with the open source projects for the respective services (e.g. Ory Kratos for Identity, Ory Keto for Permissions). This endpoint expects the `version` key to be set in the payload. If it is unset, it will try to import the config as if it is from the most recent version. If you have an older version of a configuration, you should set the version key in the payload! While this endpoint is able to process all configuration items related to features (e.g. password reset), it does not support operational configuration items (e.g. port, tracing, logging) otherwise available in the open source. For configuration items that can not be translated to Ory Cloud, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed. Be aware that updating any service's configuration will completely override your current configuration for that service!
      Parameters:
      projectId - Project ID The project's ID. (required)
      updateProject - (optional)
      _callback - The callback to be executed when the API call finishes
      Returns:
      The request call
      Throws:
      ApiException - If fail to process the API call, e.g. serializing the request body object
      Http Response Details:
      Status Code Description Response Headers
      200 successfulProjectUpdate -
      400 genericError -
      401 genericError -
      403 genericError -
      404 genericError -
      0 genericError -