ory_client v1.1.22

Ory.Api.Project (ory_client v1.1.22)

API calls for all endpoints tagged Project.

Link to this section Summary

Functions

create_project(connection, opts \\ [])

Create a Project Creates a new project.

create_project_api_key(connection, project, opts \\ [])

Create project API token Create an API token for a project.

delete_project_api_key(connection, project, token_id, opts \\ [])

Delete project API token Deletes an API token and immediately removes it.

get_active_project_in_console(connection, opts \\ [])

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

get_project(connection, project_id, opts \\ [])

Get a Project Get a projects you have access to by its ID.

get_project_members(connection, project_id, opts \\ [])

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.

list_project_api_keys(connection, project, opts \\ [])

List a project's API Tokens A list of all the project's API tokens.

list_projects(connection, opts \\ [])

List All Projects Lists all projects you have access to.

patch_project(connection, project_id, opts \\ [])

Patch an Ory Network Project Configuration 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(connection, project_id, opts \\ [])

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

remove_project_member(connection, project_id, member_id, opts \\ [])

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.

set_active_project_in_console(connection, opts \\ [])

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

set_project(connection, project_id, opts \\ [])

Update an Ory Network Project Configuration 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!

Link to this section Functions

Link to this function

create_project(connection, opts \\ [])

@spec create_project(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Ory.Model.Project.t()}
  | {:ok, Ory.Model.ErrorGeneric.t()}
  | {:error, Tesla.Env.t()}

Create a Project Creates a new project.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (CreateProjectBody):

returns

 Returns

  • {:ok, Ory.Model.Project.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

create_project_api_key(connection, project, opts \\ [])

@spec create_project_api_key(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ProjectApiKey.t()}
  | {:ok, Ory.Model.ErrorGeneric.t()}
  | {:error, Tesla.Env.t()}

Create project API token Create an API token for a project.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project (String.t): The Project ID or Project slug
  • opts (keyword): Optional parameters
    • :body (CreateProjectApiKeyRequest):

returns

 Returns

  • {:ok, Ory.Model.ProjectApiKey.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_project_api_key(connection, project, token_id, opts \\ [])

@spec delete_project_api_key(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.ErrorGeneric.t()} | {:error, Tesla.Env.t()}

Delete project API token Deletes an API token and immediately removes it.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project (String.t): The Project ID or Project slug
  • token_id (String.t): The Token ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_active_project_in_console(connection, opts \\ [])

@spec get_active_project_in_console(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Ory.Model.GenericError.t()}
  | {:ok, Ory.Model.ActiveProjectInConsole.t()}
  | {:error, Tesla.Env.t()}

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

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, Ory.Model.ActiveProjectInConsole.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_project(connection, project_id, opts \\ [])

@spec get_project(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.Project.t()}
  | {:ok, Ory.Model.ErrorGeneric.t()}
  | {:error, Tesla.Env.t()}

Get a Project Get a projects you have access to by its ID.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, Ory.Model.Project.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_project_members(connection, project_id, opts \\ [])

@spec get_project_members(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.GenericError.t()}
  | {:ok, [Ory.Model.CloudAccount.t()]}
  | {:error, Tesla.Env.t()}

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

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, [%CloudAccount{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

list_project_api_keys(connection, project, opts \\ [])

@spec list_project_api_keys(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, [Ory.Model.ProjectApiKey.t()]}
  | {:error, Tesla.Env.t()}

List a project's API Tokens A list of all the project's API tokens.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project (String.t): The Project ID or Project slug
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, [%ProjectApiKey{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

list_projects(connection, opts \\ [])

@spec list_projects(
  Tesla.Env.client(),
  keyword()
) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, [Ory.Model.ProjectMetadata.t()]}
  | {:error, Tesla.Env.t()}

List All Projects Lists all projects you have access to.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, [%ProjectMetadata{}, ...]} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

patch_project(connection, project_id, opts \\ [])

@spec patch_project(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, Ory.Model.SuccessfulProjectUpdate.t()}
  | {:error, Tesla.Env.t()}

Patch an Ory Network Project Configuration 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.

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters
    • :body ([Ory.Model.JsonPatch.t]):

returns

 Returns

  • {:ok, Ory.Model.SuccessfulProjectUpdate.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

purge_project(connection, project_id, opts \\ [])

@spec purge_project(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.GenericError.t()} | {:error, Tesla.Env.t()}

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

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

remove_project_member(connection, project_id, member_id, opts \\ [])

@spec remove_project_member(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.GenericError.t()} | {:error, Tesla.Env.t()}

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

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • member_id (String.t): Member ID
  • opts (keyword): Optional parameters

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

set_active_project_in_console(connection, opts \\ [])

@spec set_active_project_in_console(
  Tesla.Env.client(),
  keyword()
) :: {:ok, nil} | {:ok, Ory.Model.GenericError.t()} | {:error, Tesla.Env.t()}

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

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • opts (keyword): Optional parameters
    • :body (SetActiveProjectInConsoleBody):

returns

 Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

set_project(connection, project_id, opts \\ [])

@spec set_project(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorGeneric.t()}
  | {:ok, Ory.Model.SuccessfulProjectUpdate.t()}
  | {:error, Tesla.Env.t()}

Update an Ory Network Project Configuration 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!

parameters

 Parameters

  • connection (Ory.Connection): Connection to server
  • project_id (String.t): Project ID The project's ID.
  • opts (keyword): Optional parameters
    • :body (SetProject):

returns

 Returns

  • {:ok, Ory.Model.SuccessfulProjectUpdate.t} on success
  • {:error, Tesla.Env.t} on failure