# OryClient::V0alpha0Api All URIs are relative to *https://playground.projects.oryapis.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_project**](V0alpha0Api.md#create_project) | **POST** /backoffice/public/projects | Create a Project | | [**get_project**](V0alpha0Api.md#get_project) | **GET** /backoffice/public/projects/{project_id} | Get a Project | | [**list_projects**](V0alpha0Api.md#list_projects) | **GET** /backoffice/public/projects | List All Projects | | [**update_project**](V0alpha0Api.md#update_project) | **PUT** /backoffice/public/projects/{project_id} | Update a Project | | [**update_project_config**](V0alpha0Api.md#update_project_config) | **PUT** /backoffice/public/projects/{project_id}/configs | Update an Ory Cloud Project Configuration | ## create_project > create_project(opts) Create a Project Creates a new project. ### Examples ```ruby require 'time' require 'ory-client' # setup authorization OryClient.configure do |config| # Configure Bearer authorization: oryAccessToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryClient::V0alpha0Api.new opts = { project_revision: OryClient::ProjectRevision.new({name: 'name_example'}) # ProjectRevision | } begin # Create a Project result = api_instance.create_project(opts) p result rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->create_project: #{e}" end ``` #### Using the create_project_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_project_with_http_info(opts) ```ruby begin # Create a Project data, status_code, headers = api_instance.create_project_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->create_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_revision** | [**ProjectRevision**](ProjectRevision.md) | | [optional] | ### Return type [**Project**](Project.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## get_project > get_project(project_id) Get a Project Get a projects you have access to by its ID. ### Examples ```ruby require 'time' require 'ory-client' # setup authorization OryClient.configure do |config| # Configure Bearer authorization: oryAccessToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryClient::V0alpha0Api.new project_id = 'project_id_example' # String | Project ID The project's ID. begin # Get a Project result = api_instance.get_project(project_id) p result rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->get_project: #{e}" end ``` #### Using the get_project_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_project_with_http_info(project_id) ```ruby begin # Get a Project data, status_code, headers = api_instance.get_project_with_http_info(project_id) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->get_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | ### Return type [**Project**](Project.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_projects > > list_projects List All Projects Lists all projects you have access to. ### Examples ```ruby require 'time' require 'ory-client' # setup authorization OryClient.configure do |config| # Configure Bearer authorization: oryAccessToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryClient::V0alpha0Api.new begin # List All Projects result = api_instance.list_projects p result rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->list_projects: #{e}" end ``` #### Using the list_projects_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> list_projects_with_http_info ```ruby begin # List All Projects data, status_code, headers = api_instance.list_projects_with_http_info p status_code # => 2xx p headers # => { ... } p data # => > rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->list_projects_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**Array<Project>**](Project.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## update_project > update_project(project_id, opts) Update a Project Creates a new configuration revision for a project. ### Examples ```ruby require 'time' require 'ory-client' # setup authorization OryClient.configure do |config| # Configure Bearer authorization: oryAccessToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryClient::V0alpha0Api.new project_id = 'project_id_example' # String | Project ID The project's ID. opts = { project_revision: OryClient::ProjectRevision.new({name: 'name_example'}) # ProjectRevision | } begin # Update a Project result = api_instance.update_project(project_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->update_project: #{e}" end ``` #### Using the update_project_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_project_with_http_info(project_id, opts) ```ruby begin # Update a Project data, status_code, headers = api_instance.update_project_with_http_info(project_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->update_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **project_revision** | [**ProjectRevision**](ProjectRevision.md) | | [optional] | ### Return type [**Project**](Project.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_project_config > update_project_config(project_id, opts) Update an Ory Cloud Project Configuration This endpoints allows you to update the Ory Cloud 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 Ory Cloud, 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! ### Examples ```ruby require 'time' require 'ory-client' # setup authorization OryClient.configure do |config| # Configure Bearer authorization: oryAccessToken config.access_token = 'YOUR_BEARER_TOKEN' end api_instance = OryClient::V0alpha0Api.new project_id = 'project_id_example' # String | Project ID The project's ID. opts = { update_project_config_config: OryClient::UpdateProjectConfigConfig.new({identity: 3.56}) # UpdateProjectConfigConfig | } begin # Update an Ory Cloud Project Configuration result = api_instance.update_project_config(project_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->update_project_config: #{e}" end ``` #### Using the update_project_config_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_project_config_with_http_info(project_id, opts) ```ruby begin # Update an Ory Cloud Project Configuration data, status_code, headers = api_instance.update_project_config_with_http_info(project_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling V0alpha0Api->update_project_config_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **update_project_config_config** | [**UpdateProjectConfigConfig**](UpdateProjectConfigConfig.md) | | [optional] | ### Return type [**SuccessfulUpdateProjectConfig**](SuccessfulUpdateProjectConfig.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json