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

ClassMethodHTTP requestDescription
MetadataApigetVersionGET /versionReturn Running Software Version.
MetadataApiisAliveGET /health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /health/readyCheck HTTP Server and Database Status
ReadApigetCheckGET /relation-tuples/checkCheck a relation tuple
ReadApigetExpandGET /relation-tuples/expandExpand a Relation Tuple
ReadApigetRelationTuplesGET /relation-tuplesQuery relation tuples
ReadApipostCheckPOST /relation-tuples/checkCheck a relation tuple
V0alpha2ApiadminCreateIdentityPOST /admin/identitiesCreate an Identity
V0alpha2ApiadminCreateSelfServiceRecoveryLinkPOST /admin/recovery/linkCreate a Recovery Link
V0alpha2ApiadminDeleteIdentityDELETE /admin/identities/{id}Delete an Identity
V0alpha2ApiadminDeleteIdentitySessionsDELETE /admin/identities/{id}/sessionsCalling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.
V0alpha2ApiadminExtendSessionPATCH /admin/sessions/{id}/extendCalling 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.
V0alpha2ApiadminGetIdentityGET /admin/identities/{id}Get an Identity
V0alpha2ApiadminListIdentitiesGET /admin/identitiesList Identities
V0alpha2ApiadminListIdentitySessionsGET /admin/identities/{id}/sessionsThis endpoint returns all sessions that belong to the given Identity.
V0alpha2ApiadminUpdateIdentityPUT /admin/identities/{id}Update an Identity
V0alpha2ApicreateProjectPOST /projectsCreate a Project
V0alpha2ApicreateSelfServiceLogoutFlowUrlForBrowsersGET /self-service/logout/browserCreate a Logout URL for Browsers
V0alpha2ApigetJsonSchemaGET /schemas/{id}
V0alpha2ApigetProjectGET /projects/{project_id}Get a Project
V0alpha2ApigetProjectMembersGET /projects/{project_id}/membersGet all members associated with this project.
V0alpha2ApigetSelfServiceErrorGET /self-service/errorsGet Self-Service Errors
V0alpha2ApigetSelfServiceLoginFlowGET /self-service/login/flowsGet Login Flow
V0alpha2ApigetSelfServiceRecoveryFlowGET /self-service/recovery/flowsGet Recovery Flow
V0alpha2ApigetSelfServiceRegistrationFlowGET /self-service/registration/flowsGet Registration Flow
V0alpha2ApigetSelfServiceSettingsFlowGET /self-service/settings/flowsGet Settings Flow
V0alpha2ApigetSelfServiceVerificationFlowGET /self-service/verification/flowsGet Verification Flow
V0alpha2ApigetWebAuthnJavaScriptGET /.well-known/ory/webauthn.jsGet WebAuthn JavaScript
V0alpha2ApiinitializeSelfServiceLoginFlowForBrowsersGET /self-service/login/browserInitialize Login Flow for Browsers
V0alpha2ApiinitializeSelfServiceLoginFlowWithoutBrowserGET /self-service/login/apiInitialize Login Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRecoveryFlowForBrowsersGET /self-service/recovery/browserInitialize Recovery Flow for Browsers
V0alpha2ApiinitializeSelfServiceRecoveryFlowWithoutBrowserGET /self-service/recovery/apiInitialize Recovery Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceRegistrationFlowForBrowsersGET /self-service/registration/browserInitialize Registration Flow for Browsers
V0alpha2ApiinitializeSelfServiceRegistrationFlowWithoutBrowserGET /self-service/registration/apiInitialize Registration Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceSettingsFlowForBrowsersGET /self-service/settings/browserInitialize Settings Flow for Browsers
V0alpha2ApiinitializeSelfServiceSettingsFlowWithoutBrowserGET /self-service/settings/apiInitialize Settings Flow for APIs, Services, Apps, ...
V0alpha2ApiinitializeSelfServiceVerificationFlowForBrowsersGET /self-service/verification/browserInitialize Verification Flow for Browser Clients
V0alpha2ApiinitializeSelfServiceVerificationFlowWithoutBrowserGET /self-service/verification/apiInitialize Verification Flow for APIs, Services, Apps, ...
V0alpha2ApilistIdentitySchemasGET /schemas
V0alpha2ApilistProjectsGET /projectsList All Projects
V0alpha2ApilistSessionsGET /sessionsThis 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.
V0alpha2ApipatchProjectPATCH /projects/{project_id}Patch an Ory Cloud Project Configuration
V0alpha2ApipurgeProjectDELETE /projects/{project_id}Irrecoverably Purge a Project
V0alpha2ApiremoveProjectMemberDELETE /projects/{project_id}/members/{member_id}Remove a member associated with this project. This also sets their invite status to `REMOVED`.
V0alpha2ApirevokeSessionDELETE /sessions/{id}Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted.
V0alpha2ApirevokeSessionsDELETE /sessionsCalling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted.
V0alpha2ApisubmitSelfServiceLoginFlowPOST /self-service/loginSubmit a Login Flow
V0alpha2ApisubmitSelfServiceLogoutFlowGET /self-service/logoutComplete Self-Service Logout
V0alpha2ApisubmitSelfServiceLogoutFlowWithoutBrowserDELETE /self-service/logout/apiPerform Logout for APIs, Services, Apps, ...
V0alpha2ApisubmitSelfServiceRecoveryFlowPOST /self-service/recoveryComplete Recovery Flow
V0alpha2ApisubmitSelfServiceRegistrationFlowPOST /self-service/registrationSubmit a Registration Flow
V0alpha2ApisubmitSelfServiceSettingsFlowPOST /self-service/settingsComplete Settings Flow
V0alpha2ApisubmitSelfServiceVerificationFlowPOST /self-service/verificationComplete Verification Flow
V0alpha2ApitoSessionGET /sessions/whoamiCheck Who the Current HTTP Session Belongs To
V0alpha2ApiupdateProjectPUT /projects/{project_id}Update an Ory Cloud Project Configuration
WriteApicreateRelationTuplePUT /admin/relation-tuplesCreate a Relation Tuple
WriteApideleteRelationTuplesDELETE /admin/relation-tuplesDelete Relation Tuples
WriteApipatchRelationTuplesPATCH /admin/relation-tuplesPatch Multiple Relation Tuples

Documentation For Models

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_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.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_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
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