Module ory_client::apis::project_api

Enums

CreateProjectApiKeyError

struct for typed errors of method create_project_api_key

CreateProjectError

struct for typed errors of method create_project

DeleteProjectApiKeyError

struct for typed errors of method delete_project_api_key

GetActiveProjectInConsoleError

struct for typed errors of method get_active_project_in_console

GetProjectError

struct for typed errors of method get_project

GetProjectMembersError

struct for typed errors of method get_project_members

ListProjectApiKeysError

struct for typed errors of method list_project_api_keys

ListProjectsError

struct for typed errors of method list_projects

PatchProjectError

struct for typed errors of method patch_project

PurgeProjectError

struct for typed errors of method purge_project

RemoveProjectMemberError

struct for typed errors of method remove_project_member

SetActiveProjectInConsoleError

struct for typed errors of method set_active_project_in_console

SetProjectError

struct for typed errors of method set_project

Functions

create_project

Creates a new project.

create_project_api_key

Create an API token for a project.

delete_project_api_key

Deletes an API token and immediately removes it.

get_active_project_in_console

Use this API to get your active project in the Ory Network Console UI.

get_project

Get a projects you have access to by its ID.

get_project_members

This endpoint requires the user to be a member of the project with the role OWNER or DEVELOPER.

list_project_api_keys

A list of all the project’s API tokens.

list_projects

Lists all projects you have access to.

patch_project

Deprecated: Use the patchProjectWithRevision endpoint instead to specify the exact revision the patch was generated for. This endpoints allows you to patch individual Ory Network 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 the Ory Network, this endpoint will return a list of warnings to help you understand which parts of your config could not be processed.

purge_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 !!

remove_project_member

This also sets their invite status to REMOVED. This endpoint requires the user to be a member of the project with the role OWNER.

set_active_project_in_console

Use this API to set your active project in the Ory Network Console UI.

set_project

This endpoints allows you to update the Ory Network 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 the Ory Network, 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!