This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more.
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version:
- Package version:
- Build package: org.openapitools.codegen.languages.Swift5ClientCodegen
Run carthage update
Run pod install
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
CourierAPI | getCourierMessage | GET /admin/courier/messages/{id} | Get a Message |
CourierAPI | listCourierMessages | GET /admin/courier/messages | List Messages |
FrontendAPI | createBrowserLoginFlow | GET /self-service/login/browser | Create Login Flow for Browsers |
FrontendAPI | createBrowserLogoutFlow | GET /self-service/logout/browser | Create a Logout URL for Browsers |
FrontendAPI | createBrowserRecoveryFlow | GET /self-service/recovery/browser | Create Recovery Flow for Browsers |
FrontendAPI | createBrowserRegistrationFlow | GET /self-service/registration/browser | Create Registration Flow for Browsers |
FrontendAPI | createBrowserSettingsFlow | GET /self-service/settings/browser | Create Settings Flow for Browsers |
FrontendAPI | createBrowserVerificationFlow | GET /self-service/verification/browser | Create Verification Flow for Browser Clients |
FrontendAPI | createNativeLoginFlow | GET /self-service/login/api | Create Login Flow for Native Apps |
FrontendAPI | createNativeRecoveryFlow | GET /self-service/recovery/api | Create Recovery Flow for Native Apps |
FrontendAPI | createNativeRegistrationFlow | GET /self-service/registration/api | Create Registration Flow for Native Apps |
FrontendAPI | createNativeSettingsFlow | GET /self-service/settings/api | Create Settings Flow for Native Apps |
FrontendAPI | createNativeVerificationFlow | GET /self-service/verification/api | Create Verification Flow for Native Apps |
FrontendAPI | disableMyOtherSessions | DELETE /sessions | Disable my other sessions |
FrontendAPI | disableMySession | DELETE /sessions/{id} | Disable one of my sessions |
FrontendAPI | exchangeSessionToken | GET /sessions/token-exchange | Exchange Session Token |
FrontendAPI | getFlowError | GET /self-service/errors | Get User-Flow Errors |
FrontendAPI | getLoginFlow | GET /self-service/login/flows | Get Login Flow |
FrontendAPI | getRecoveryFlow | GET /self-service/recovery/flows | Get Recovery Flow |
FrontendAPI | getRegistrationFlow | GET /self-service/registration/flows | Get Registration Flow |
FrontendAPI | getSettingsFlow | GET /self-service/settings/flows | Get Settings Flow |
FrontendAPI | getVerificationFlow | GET /self-service/verification/flows | Get Verification Flow |
FrontendAPI | getWebAuthnJavaScript | GET /.well-known/ory/webauthn.js | Get WebAuthn JavaScript |
FrontendAPI | listMySessions | GET /sessions | Get My Active Sessions |
FrontendAPI | performNativeLogout | DELETE /self-service/logout/api | Perform Logout for Native Apps |
FrontendAPI | toSession | GET /sessions/whoami | Check Who the Current HTTP Session Belongs To |
FrontendAPI | updateLoginFlow | POST /self-service/login | Submit a Login Flow |
FrontendAPI | updateLogoutFlow | GET /self-service/logout | Update Logout Flow |
FrontendAPI | updateRecoveryFlow | POST /self-service/recovery | Complete Recovery Flow |
FrontendAPI | updateRegistrationFlow | POST /self-service/registration | Update Registration Flow |
FrontendAPI | updateSettingsFlow | POST /self-service/settings | Complete Settings Flow |
FrontendAPI | updateVerificationFlow | POST /self-service/verification | Complete Verification Flow |
IdentityAPI | batchPatchIdentities | PATCH /admin/identities | Create and deletes multiple identities |
IdentityAPI | createIdentity | POST /admin/identities | Create an Identity |
IdentityAPI | createRecoveryCodeForIdentity | POST /admin/recovery/code | Create a Recovery Code |
IdentityAPI | createRecoveryLinkForIdentity | POST /admin/recovery/link | Create a Recovery Link |
IdentityAPI | deleteIdentity | DELETE /admin/identities/{id} | Delete an Identity |
IdentityAPI | deleteIdentityCredentials | DELETE /admin/identities/{id}/credentials/{type} | Delete a credential for a specific identity |
IdentityAPI | deleteIdentitySessions | DELETE /admin/identities/{id}/sessions | Delete & Invalidate an Identity's Sessions |
IdentityAPI | disableSession | DELETE /admin/sessions/{id} | Deactivate a Session |
IdentityAPI | extendSession | PATCH /admin/sessions/{id}/extend | Extend a Session |
IdentityAPI | getIdentity | GET /admin/identities/{id} | Get an Identity |
IdentityAPI | getIdentitySchema | GET /schemas/{id} | Get Identity JSON Schema |
IdentityAPI | getSession | GET /admin/sessions/{id} | Get Session |
IdentityAPI | listIdentities | GET /admin/identities | List Identities |
IdentityAPI | listIdentitySchemas | GET /schemas | Get all Identity Schemas |
IdentityAPI | listIdentitySessions | GET /admin/identities/{id}/sessions | List an Identity's Sessions |
IdentityAPI | listSessions | GET /admin/sessions | List All Sessions |
IdentityAPI | patchIdentity | PATCH /admin/identities/{id} | Patch an Identity |
IdentityAPI | updateIdentity | PUT /admin/identities/{id} | Update an Identity |
MetadataAPI | getVersion | GET /version | Return Running Software Version. |
MetadataAPI | isAlive | GET /health/alive | Check HTTP Server Status |
MetadataAPI | isReady | GET /health/ready | Check HTTP Server and Database Status |
- AuthenticatorAssuranceLevel
- BatchPatchIdentitiesResponse
- ContinueWith
- ContinueWithSetOrySessionToken
- ContinueWithVerificationUi
- ContinueWithVerificationUiFlow
- CourierMessageStatus
- CourierMessageType
- CreateIdentityBody
- CreateRecoveryCodeForIdentityBody
- CreateRecoveryLinkForIdentityBody
- DeleteMySessionsCount
- ErrorAuthenticatorAssuranceLevelNotSatisfied
- ErrorBrowserLocationChangeRequired
- ErrorFlowReplaced
- ErrorGeneric
- FlowError
- GenericError
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- Identity
- IdentityCredentials
- IdentityCredentialsOidc
- IdentityCredentialsOidcProvider
- IdentityCredentialsPassword
- IdentityCredentialsType
- IdentityPatch
- IdentityPatchResponse
- IdentitySchemaContainer
- IdentityState
- IdentityWithCredentials
- IdentityWithCredentialsOidc
- IdentityWithCredentialsOidcConfig
- IdentityWithCredentialsOidcConfigProvider
- IdentityWithCredentialsPassword
- IdentityWithCredentialsPasswordConfig
- IsAlive200Response
- IsReady503Response
- JsonPatch
- LoginFlow
- LogoutFlow
- Message
- MessageDispatch
- NeedsPrivilegedSessionError
- OAuth2Client
- OAuth2ConsentRequestOpenIDConnectContext
- OAuth2LoginRequest
- Pagination
- PatchIdentitiesBody
- PerformNativeLogoutBody
- RecoveryCodeForIdentity
- RecoveryFlow
- RecoveryFlowState
- RecoveryIdentityAddress
- RecoveryLinkForIdentity
- RegistrationFlow
- SelfServiceFlowExpiredError
- Session
- SessionAuthenticationMethod
- SessionDevice
- SettingsFlow
- SettingsFlowState
- SuccessfulCodeExchangeResponse
- SuccessfulNativeLogin
- SuccessfulNativeRegistration
- TokenPagination
- TokenPaginationHeaders
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeMeta
- UiNodeScriptAttributes
- UiNodeTextAttributes
- UiText
- UpdateIdentityBody
- UpdateLoginFlowBody
- UpdateLoginFlowWithLookupSecretMethod
- UpdateLoginFlowWithOidcMethod
- UpdateLoginFlowWithPasswordMethod
- UpdateLoginFlowWithTotpMethod
- UpdateLoginFlowWithWebAuthnMethod
- UpdateRecoveryFlowBody
- UpdateRecoveryFlowWithCodeMethod
- UpdateRecoveryFlowWithLinkMethod
- UpdateRegistrationFlowBody
- UpdateRegistrationFlowWithOidcMethod
- UpdateRegistrationFlowWithPasswordMethod
- UpdateRegistrationFlowWithWebAuthnMethod
- UpdateSettingsFlowBody
- UpdateSettingsFlowWithLookupMethod
- UpdateSettingsFlowWithOidcMethod
- UpdateSettingsFlowWithPasswordMethod
- UpdateSettingsFlowWithProfileMethod
- UpdateSettingsFlowWithTotpMethod
- UpdateSettingsFlowWithWebAuthnMethod
- UpdateVerificationFlowBody
- UpdateVerificationFlowWithCodeMethod
- UpdateVerificationFlowWithLinkMethod
- VerifiableIdentityAddress
- VerificationFlow
- VerificationFlowState
- Version
Authentication schemes defined for the API:
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header