ory_client
Documentation for all public and administrative Ory APIs. Administrative APIs can only be accessed with a valid Personal Access Token. Public APIs are mostly used in browsers.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.0.1-alpha.189
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements
Dart 2.7.0 or later OR Flutter 1.12 or later
Installation & Usage
Github
If this Dart package is published to Github, please include the following in pubspec.yaml
name: ory_client
version: 0.0.1-alpha.189
description: OpenAPI API client
dependencies:
ory_client:
git: https://github.com/ory/sdk.git
version: 'any'
Local
To use the package in your local drive, please include the following in pubspec.yaml
dependencies:
ory_client:
path: /path/to/ory_client
Getting Started
Please follow the installation procedure and then run the following:
import 'package:ory_client/api.dart';
final api = MetadataApi();
try {
final response = await api.getVersion();
print(response);
} catch (e) {
print("Exception when calling MetadataApi->getVersion: $e\n");
}
Documentation for API Endpoints
All URIs are relative to https://playground.projects.oryapis.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| 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 |
| ReadApi | getCheck | GET /relation-tuples/check | Check a relation tuple |
| ReadApi | getExpand | GET /relation-tuples/expand | Expand a Relation Tuple |
| ReadApi | getRelationTuples | GET /relation-tuples | Query relation tuples |
| ReadApi | postCheck | POST /relation-tuples/check | Check a relation tuple |
| V0alpha2Api | adminCreateIdentity | POST /admin/identities | Create an Identity |
| V0alpha2Api | adminCreateSelfServiceRecoveryLink | POST /admin/recovery/link | Create a Recovery Link |
| V0alpha2Api | adminDeleteIdentity | DELETE /admin/identities/{id} | Delete an Identity |
| V0alpha2Api | adminDeleteIdentitySessions | DELETE /admin/identities/{id}/sessions | Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity. |
| V0alpha2Api | adminExtendSession | PATCH /admin/sessions/{id}/extend | 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. |
| V0alpha2Api | adminGetIdentity | GET /admin/identities/{id} | Get an Identity |
| V0alpha2Api | adminListIdentities | GET /admin/identities | List Identities |
| V0alpha2Api | adminListIdentitySessions | GET /admin/identities/{id}/sessions | This endpoint returns all sessions that belong to the given Identity. |
| V0alpha2Api | adminUpdateIdentity | PUT /admin/identities/{id} | Update an Identity |
| V0alpha2Api | createProject | POST /projects | Create a Project |
| V0alpha2Api | createSelfServiceLogoutFlowUrlForBrowsers | GET /self-service/logout/browser | Create a Logout URL for Browsers |
| V0alpha2Api | getJsonSchema | GET /schemas/{id} | |
| V0alpha2Api | getProject | GET /projects/{project_id} | Get a Project |
| V0alpha2Api | getProjectMembers | GET /projects/{project_id}/members | Get all members associated with this project. |
| V0alpha2Api | getSelfServiceError | GET /self-service/errors | Get Self-Service Errors |
| V0alpha2Api | getSelfServiceLoginFlow | GET /self-service/login/flows | Get Login Flow |
| V0alpha2Api | getSelfServiceRecoveryFlow | GET /self-service/recovery/flows | Get Recovery Flow |
| V0alpha2Api | getSelfServiceRegistrationFlow | GET /self-service/registration/flows | Get Registration Flow |
| V0alpha2Api | getSelfServiceSettingsFlow | GET /self-service/settings/flows | Get Settings Flow |
| V0alpha2Api | getSelfServiceVerificationFlow | GET /self-service/verification/flows | Get Verification Flow |
| V0alpha2Api | getWebAuthnJavaScript | GET /.well-known/ory/webauthn.js | Get WebAuthn JavaScript |
| V0alpha2Api | initializeSelfServiceLoginFlowForBrowsers | GET /self-service/login/browser | Initialize Login Flow for Browsers |
| V0alpha2Api | initializeSelfServiceLoginFlowWithoutBrowser | GET /self-service/login/api | Initialize Login Flow for APIs, Services, Apps, ... |
| V0alpha2Api | initializeSelfServiceRecoveryFlowForBrowsers | GET /self-service/recovery/browser | Initialize Recovery Flow for Browsers |
| V0alpha2Api | initializeSelfServiceRecoveryFlowWithoutBrowser | GET /self-service/recovery/api | Initialize Recovery Flow for APIs, Services, Apps, ... |
| V0alpha2Api | initializeSelfServiceRegistrationFlowForBrowsers | GET /self-service/registration/browser | Initialize Registration Flow for Browsers |
| V0alpha2Api | initializeSelfServiceRegistrationFlowWithoutBrowser | GET /self-service/registration/api | Initialize Registration Flow for APIs, Services, Apps, ... |
| V0alpha2Api | initializeSelfServiceSettingsFlowForBrowsers | GET /self-service/settings/browser | Initialize Settings Flow for Browsers |
| V0alpha2Api | initializeSelfServiceSettingsFlowWithoutBrowser | GET /self-service/settings/api | Initialize Settings Flow for APIs, Services, Apps, ... |
| V0alpha2Api | initializeSelfServiceVerificationFlowForBrowsers | GET /self-service/verification/browser | Initialize Verification Flow for Browser Clients |
| V0alpha2Api | initializeSelfServiceVerificationFlowWithoutBrowser | GET /self-service/verification/api | Initialize Verification Flow for APIs, Services, Apps, ... |
| V0alpha2Api | listIdentitySchemas | GET /schemas | |
| V0alpha2Api | listProjects | GET /projects | List All Projects |
| V0alpha2Api | listSessions | GET /sessions | 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. |
| V0alpha2Api | patchProject | PATCH /projects/{project_id} | Patch an Ory Cloud Project Configuration |
| V0alpha2Api | purgeProject | DELETE /projects/{project_id} | Irrecoverably Purge a Project |
| V0alpha2Api | removeProjectMember | DELETE /projects/{project_id}/members/{member_id} | Remove a member associated with this project. This also sets their invite status to `REMOVED`. |
| V0alpha2Api | revokeSession | DELETE /sessions/{id} | Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. |
| V0alpha2Api | revokeSessions | DELETE /sessions | Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. |
| V0alpha2Api | submitSelfServiceLoginFlow | POST /self-service/login | Submit a Login Flow |
| V0alpha2Api | submitSelfServiceLogoutFlow | GET /self-service/logout | Complete Self-Service Logout |
| V0alpha2Api | submitSelfServiceLogoutFlowWithoutBrowser | DELETE /self-service/logout/api | Perform Logout for APIs, Services, Apps, ... |
| V0alpha2Api | submitSelfServiceRecoveryFlow | POST /self-service/recovery | Complete Recovery Flow |
| V0alpha2Api | submitSelfServiceRegistrationFlow | POST /self-service/registration | Submit a Registration Flow |
| V0alpha2Api | submitSelfServiceSettingsFlow | POST /self-service/settings | Complete Settings Flow |
| V0alpha2Api | submitSelfServiceVerificationFlow | POST /self-service/verification | Complete Verification Flow |
| V0alpha2Api | toSession | GET /sessions/whoami | Check Who the Current HTTP Session Belongs To |
| V0alpha2Api | updateProject | PUT /projects/{project_id} | Update an Ory Cloud Project Configuration |
| WriteApi | createRelationTuple | PUT /admin/relation-tuples | Create a Relation Tuple |
| WriteApi | deleteRelationTuples | DELETE /admin/relation-tuples | Delete Relation Tuples |
| WriteApi | patchRelationTuples | PATCH /admin/relation-tuples | Patch Multiple Relation Tuples |
Documentation For Models
- ActiveProject
- AdminCreateIdentityBody
- AdminCreateIdentityImportCredentialsOidc
- AdminCreateIdentityImportCredentialsOidcConfig
- AdminCreateIdentityImportCredentialsOidcProvider
- AdminCreateIdentityImportCredentialsPassword
- AdminCreateIdentityImportCredentialsPasswordConfig
- AdminCreateSelfServiceRecoveryLinkBody
- AdminIdentityImportCredentials
- AdminUpdateIdentityBody
- ApiToken
- AuthenticatorAssuranceLevel
- CloudAccount
- CnameSettings
- CreateCustomHostnameBody
- CreateProjectBody
- CreateSubscriptionPayload
- ErrorAuthenticatorAssuranceLevelNotSatisfied
- ExpandTree
- GenericError
- GenericErrorContent
- GetCheckResponse
- GetRelationTuplesResponse
- HealthNotReadyStatus
- HealthStatus
- Identity
- IdentityCredentials
- IdentityCredentialsOidc
- IdentityCredentialsOidcProvider
- IdentityCredentialsPassword
- IdentityCredentialsType
- IdentitySchema
- IdentitySchemaLocation
- IdentitySchemaPreset
- IdentitySchemaValidationResult
- IdentityState
- InlineResponse200
- InlineResponse2001
- InlineResponse503
- InternalRelationTuple
- InvitePayload
- IsOwnerForProjectBySlug
- IsOwnerForProjectBySlugPayload
- JsonError
- JsonPatch
- KetoNamespace
- NeedsPrivilegedSessionError
- NormalizedProject
- NormalizedProjectRevision
- NormalizedProjectRevisionHook
- NormalizedProjectRevisionIdentitySchema
- NormalizedProjectRevisionThirdPartyProvider
- NullPlan
- Pagination
- PatchDelta
- Project
- ProjectHost
- ProjectInvite
- ProjectMetadata
- ProjectServiceIdentity
- ProjectServicePermission
- ProjectServices
- ProvisionMockSubscriptionPayload
- QuotaProjectMemberSeats
- RecoveryAddress
- RelationQuery
- RevokedSessions
- SchemaPatch
- SelfServiceBrowserLocationChangeRequiredError
- SelfServiceError
- SelfServiceFlowExpiredError
- SelfServiceLoginFlow
- SelfServiceLogoutUrl
- SelfServiceRecoveryFlow
- SelfServiceRecoveryFlowState
- SelfServiceRecoveryLink
- SelfServiceRegistrationFlow
- SelfServiceSettingsFlow
- SelfServiceSettingsFlowState
- SelfServiceVerificationFlow
- SelfServiceVerificationFlowState
- Session
- SessionAuthenticationMethod
- SessionDevice
- SettingsProfileFormConfig
- StripeCustomerResponse
- SubjectSet
- SubmitSelfServiceFlowWithWebAuthnRegistrationMethod
- SubmitSelfServiceLoginFlowBody
- SubmitSelfServiceLoginFlowWithLookupSecretMethodBody
- SubmitSelfServiceLoginFlowWithOidcMethodBody
- SubmitSelfServiceLoginFlowWithPasswordMethodBody
- SubmitSelfServiceLoginFlowWithTotpMethodBody
- SubmitSelfServiceLoginFlowWithWebAuthnMethodBody
- SubmitSelfServiceLogoutFlowWithoutBrowserBody
- SubmitSelfServiceRecoveryFlowBody
- SubmitSelfServiceRecoveryFlowWithLinkMethodBody
- SubmitSelfServiceRegistrationFlowBody
- SubmitSelfServiceRegistrationFlowWithOidcMethodBody
- SubmitSelfServiceRegistrationFlowWithPasswordMethodBody
- SubmitSelfServiceRegistrationFlowWithWebAuthnMethodBody
- SubmitSelfServiceSettingsFlowBody
- SubmitSelfServiceSettingsFlowWithLookupMethodBody
- SubmitSelfServiceSettingsFlowWithOidcMethodBody
- SubmitSelfServiceSettingsFlowWithPasswordMethodBody
- SubmitSelfServiceSettingsFlowWithProfileMethodBody
- SubmitSelfServiceSettingsFlowWithTotpMethodBody
- SubmitSelfServiceSettingsFlowWithWebAuthnMethodBody
- SubmitSelfServiceVerificationFlowBody
- SubmitSelfServiceVerificationFlowWithLinkMethodBody
- Subscription
- SuccessfulProjectUpdate
- SuccessfulSelfServiceLoginWithoutBrowser
- SuccessfulSelfServiceRegistrationWithoutBrowser
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeMeta
- UiNodeScriptAttributes
- UiNodeTextAttributes
- UiText
- UpdateCustomHostnameBody
- UpdateProject
- UpdateSubscriptionPayload
- VerifiableIdentityAddress
- Version
- Warning
Documentation For Authorization
oryAccessToken
- Type: HTTP basic authentication
Author
support@ory.sh
Libraries
- active_project
- active_project.g
- admin_create_identity_body
- admin_create_identity_body.g
- admin_create_identity_import_credentials_oidc
- admin_create_identity_import_credentials_oidc.g
- admin_create_identity_import_credentials_oidc_config
- admin_create_identity_import_credentials_oidc_config.g
- admin_create_identity_import_credentials_oidc_provider
- admin_create_identity_import_credentials_oidc_provider.g
- admin_create_identity_import_credentials_password
- admin_create_identity_import_credentials_password.g
- admin_create_identity_import_credentials_password_config
- admin_create_identity_import_credentials_password_config.g
- admin_create_self_service_recovery_link_body
- admin_create_self_service_recovery_link_body.g
- admin_identity_import_credentials
- admin_identity_import_credentials.g
- admin_update_identity_body
- admin_update_identity_body.g
- api_key_auth
- api_token
- api_token.g
- api_util
- auth
- authenticator_assurance_level
- authenticator_assurance_level.g
- basic_auth
- cloud_account
- cloud_account.g
- cname_settings
- cname_settings.g
- create_custom_hostname_body
- create_custom_hostname_body.g
- create_project_body
- create_project_body.g
- create_subscription_payload
- create_subscription_payload.g
- error_authenticator_assurance_level_not_satisfied
- error_authenticator_assurance_level_not_satisfied.g
- expand_tree
- expand_tree.g
- generic_error
- generic_error.g
- generic_error_content
- generic_error_content.g
- get_check_response
- get_check_response.g
- get_relation_tuples_response
- get_relation_tuples_response.g
- health_not_ready_status
- health_not_ready_status.g
- health_status
- health_status.g
- identity
- identity.g
- identity_credentials
- identity_credentials.g
- identity_credentials_oidc
- identity_credentials_oidc.g
- identity_credentials_oidc_provider
- identity_credentials_oidc_provider.g
- identity_credentials_password
- identity_credentials_password.g
- identity_credentials_type
- identity_credentials_type.g
- identity_schema
- identity_schema.g
- identity_schema_location
- identity_schema_location.g
- identity_schema_preset
- identity_schema_preset.g
- identity_schema_validation_result
- identity_schema_validation_result.g
- identity_state
- identity_state.g
- inline_response200
- inline_response200.g
- inline_response503
- inline_response503.g
- inline_response2001
- inline_response2001.g
- internal_relation_tuple
- internal_relation_tuple.g
- invite_payload
- invite_payload.g
- is_owner_for_project_by_slug
- is_owner_for_project_by_slug.g
- is_owner_for_project_by_slug_payload
- is_owner_for_project_by_slug_payload.g
- json_error
- json_error.g
- json_patch
- json_patch.g
- keto_namespace
- keto_namespace.g
- metadata_api
- needs_privileged_session_error
- needs_privileged_session_error.g
- normalized_project
- normalized_project.g
- normalized_project_revision
- normalized_project_revision.g
- normalized_project_revision_hook
- normalized_project_revision_hook.g
- normalized_project_revision_identity_schema
- normalized_project_revision_identity_schema.g
- normalized_project_revision_third_party_provider
- normalized_project_revision_third_party_provider.g
- null_plan
- null_plan.g
- oauth
- ory_client.api
- pagination
- pagination.g
- patch_delta
- patch_delta.g
- project
- project.g
- project_host
- project_host.g
- project_invite
- project_invite.g
- project_metadata
- project_metadata.g
- project_service_identity
- project_service_identity.g
- project_service_permission
- project_service_permission.g
- project_services
- project_services.g
- provision_mock_subscription_payload
- provision_mock_subscription_payload.g
- quota_project_member_seats
- quota_project_member_seats.g
- read_api
- recovery_address
- recovery_address.g
- relation_query
- relation_query.g
- revoked_sessions
- revoked_sessions.g
- schema_patch
- schema_patch.g
- self_service_browser_location_change_required_error
- self_service_browser_location_change_required_error.g
- self_service_error
- self_service_error.g
- self_service_flow_expired_error
- self_service_flow_expired_error.g
- self_service_login_flow
- self_service_login_flow.g
- self_service_logout_url
- self_service_logout_url.g
- self_service_recovery_flow
- self_service_recovery_flow.g
- self_service_recovery_flow_state
- self_service_recovery_flow_state.g
- self_service_recovery_link
- self_service_recovery_link.g
- self_service_registration_flow
- self_service_registration_flow.g
- self_service_settings_flow
- self_service_settings_flow.g
- self_service_settings_flow_state
- self_service_settings_flow_state.g
- self_service_verification_flow
- self_service_verification_flow.g
- self_service_verification_flow_state
- self_service_verification_flow_state.g
- serializers
- serializers.g
- session
- session.g
- session_authentication_method
- session_authentication_method.g
- session_device
- session_device.g
- settings_profile_form_config
- settings_profile_form_config.g
- stripe_customer_response
- stripe_customer_response.g
- subject_set
- subject_set.g
- submit_self_service_flow_with_web_authn_registration_method
- submit_self_service_flow_with_web_authn_registration_method.g
- submit_self_service_login_flow_body
- submit_self_service_login_flow_body.g
- submit_self_service_login_flow_with_lookup_secret_method_body
- submit_self_service_login_flow_with_lookup_secret_method_body.g
- submit_self_service_login_flow_with_oidc_method_body
- submit_self_service_login_flow_with_oidc_method_body.g
- submit_self_service_login_flow_with_password_method_body
- submit_self_service_login_flow_with_password_method_body.g
- submit_self_service_login_flow_with_totp_method_body
- submit_self_service_login_flow_with_totp_method_body.g
- submit_self_service_login_flow_with_web_authn_method_body
- submit_self_service_login_flow_with_web_authn_method_body.g
- submit_self_service_logout_flow_without_browser_body
- submit_self_service_logout_flow_without_browser_body.g
- submit_self_service_recovery_flow_body
- submit_self_service_recovery_flow_body.g
- submit_self_service_recovery_flow_with_link_method_body
- submit_self_service_recovery_flow_with_link_method_body.g
- submit_self_service_registration_flow_body
- submit_self_service_registration_flow_body.g
- submit_self_service_registration_flow_with_oidc_method_body
- submit_self_service_registration_flow_with_oidc_method_body.g
- submit_self_service_registration_flow_with_password_method_body
- submit_self_service_registration_flow_with_password_method_body.g
- submit_self_service_registration_flow_with_web_authn_method_body
- submit_self_service_registration_flow_with_web_authn_method_body.g
- submit_self_service_settings_flow_body
- submit_self_service_settings_flow_body.g
- submit_self_service_settings_flow_with_lookup_method_body
- submit_self_service_settings_flow_with_lookup_method_body.g
- submit_self_service_settings_flow_with_oidc_method_body
- submit_self_service_settings_flow_with_oidc_method_body.g
- submit_self_service_settings_flow_with_password_method_body
- submit_self_service_settings_flow_with_password_method_body.g
- submit_self_service_settings_flow_with_profile_method_body
- submit_self_service_settings_flow_with_profile_method_body.g
- submit_self_service_settings_flow_with_totp_method_body
- submit_self_service_settings_flow_with_totp_method_body.g
- submit_self_service_settings_flow_with_web_authn_method_body
- submit_self_service_settings_flow_with_web_authn_method_body.g
- submit_self_service_verification_flow_body
- submit_self_service_verification_flow_body.g
- submit_self_service_verification_flow_with_link_method_body
- submit_self_service_verification_flow_with_link_method_body.g
- subscription
- subscription.g
- successful_project_update
- successful_project_update.g
- successful_self_service_login_without_browser
- successful_self_service_login_without_browser.g
- successful_self_service_registration_without_browser
- successful_self_service_registration_without_browser.g
- ui_container
- ui_container.g
- ui_node
- ui_node.g
- ui_node_anchor_attributes
- ui_node_anchor_attributes.g
- ui_node_attributes
- ui_node_attributes.g
- ui_node_image_attributes
- ui_node_image_attributes.g
- ui_node_input_attributes
- ui_node_input_attributes.g
- ui_node_meta
- ui_node_meta.g
- ui_node_script_attributes
- ui_node_script_attributes.g
- ui_node_text_attributes
- ui_node_text_attributes.g
- ui_text
- ui_text.g
- update_custom_hostname_body
- update_custom_hostname_body.g
- update_project
- update_project.g
- update_subscription_payload
- update_subscription_payload.g
- v0alpha2_api
- verifiable_identity_address
- verifiable_identity_address.g
- version
- version.g
- warning
- warning.g
- write_api