# OryClient::ProjectApi All URIs are relative to *https://playground.projects.oryapis.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_organization**](ProjectApi.md#create_organization) | **POST** /projects/{project_id}/organizations | | | [**create_project**](ProjectApi.md#create_project) | **POST** /projects | Create a Project | | [**create_project_api_key**](ProjectApi.md#create_project_api_key) | **POST** /projects/{project}/tokens | Create project API token | | [**delete_organization**](ProjectApi.md#delete_organization) | **DELETE** /projects/{project_id}/organizations/{organization_id} | Delete a B2B SSO Organization for a project. | | [**delete_project_api_key**](ProjectApi.md#delete_project_api_key) | **DELETE** /projects/{project}/tokens/{token_id} | Delete project API token | | [**get_active_project_in_console**](ProjectApi.md#get_active_project_in_console) | **GET** /console/active/project | Returns the Ory Network Project selected in the Ory Network Console | | [**get_project**](ProjectApi.md#get_project) | **GET** /projects/{project_id} | Get a Project | | [**get_project_members**](ProjectApi.md#get_project_members) | **GET** /projects/{project}/members | Get all members associated with this project | | [**get_project_metrics**](ProjectApi.md#get_project_metrics) | **GET** /projects/{project_id}/metrics | | | [**list_organizations**](ProjectApi.md#list_organizations) | **GET** /projects/{project_id}/organizations | | | [**list_project_api_keys**](ProjectApi.md#list_project_api_keys) | **GET** /projects/{project}/tokens | List a project's API Tokens | | [**list_projects**](ProjectApi.md#list_projects) | **GET** /projects | List All Projects | | [**patch_project**](ProjectApi.md#patch_project) | **PATCH** /projects/{project_id} | Patch an Ory Network Project Configuration | | [**purge_project**](ProjectApi.md#purge_project) | **DELETE** /projects/{project_id} | Irrecoverably purge a project | | [**remove_project_member**](ProjectApi.md#remove_project_member) | **DELETE** /projects/{project}/members/{member} | Remove a member associated with this project | | [**set_active_project_in_console**](ProjectApi.md#set_active_project_in_console) | **PUT** /console/active/project | Sets the Ory Network Project active in the Ory Network Console | | [**set_project**](ProjectApi.md#set_project) | **PUT** /projects/{project_id} | Update an Ory Network Project Configuration | | [**update_organization**](ProjectApi.md#update_organization) | **PUT** /projects/{project_id}/organizations/{organization_id} | Update a B2B SSO Organization for a project. | ## create_organization > create_organization(project_id, opts) Create a B2B SSO Organization ### 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. opts = { organization_body: OryClient::OrganizationBody.new # OrganizationBody | } begin result = api_instance.create_organization(project_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->create_organization: #{e}" end ``` #### Using the create_organization_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_organization_with_http_info(project_id, opts) ```ruby begin data, status_code, headers = api_instance.create_organization_with_http_info(project_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->create_organization_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **organization_body** | [**OrganizationBody**](OrganizationBody.md) | | [optional] | ### Return type [**Organization**](Organization.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## 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::ProjectApi.new opts = { create_project_body: OryClient::CreateProjectBody.new({name: 'name_example'}) # CreateProjectBody | } begin # Create a Project result = api_instance.create_project(opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->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 ProjectApi->create_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **create_project_body** | [**CreateProjectBody**](CreateProjectBody.md) | | [optional] | ### Return type [**Project**](Project.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## create_project_api_key > create_project_api_key(project, opts) Create project API token Create an API token 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::ProjectApi.new project = 'project_example' # String | The Project ID or Project slug opts = { create_project_api_key_request: OryClient::CreateProjectApiKeyRequest.new({name: 'name_example'}) # CreateProjectApiKeyRequest | } begin # Create project API token result = api_instance.create_project_api_key(project, opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->create_project_api_key: #{e}" end ``` #### Using the create_project_api_key_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_project_api_key_with_http_info(project, opts) ```ruby begin # Create project API token data, status_code, headers = api_instance.create_project_api_key_with_http_info(project, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->create_project_api_key_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project** | **String** | The Project ID or Project slug | | | **create_project_api_key_request** | [**CreateProjectApiKeyRequest**](CreateProjectApiKeyRequest.md) | | [optional] | ### Return type [**ProjectApiKey**](ProjectApiKey.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## delete_organization > delete_organization(project_id, organization_id) Delete a B2B SSO Organization 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. organization_id = 'organization_id_example' # String | Organization ID The Organization's ID. begin # Delete a B2B SSO Organization for a project. api_instance.delete_organization(project_id, organization_id) rescue OryClient::ApiError => e puts "Error when calling ProjectApi->delete_organization: #{e}" end ``` #### Using the delete_organization_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > delete_organization_with_http_info(project_id, organization_id) ```ruby begin # Delete a B2B SSO Organization for a project. data, status_code, headers = api_instance.delete_organization_with_http_info(project_id, organization_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling ProjectApi->delete_organization_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **organization_id** | **String** | Organization ID The Organization's ID. | | ### Return type nil (empty response body) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## delete_project_api_key > delete_project_api_key(project, token_id) Delete project API token Deletes an API token and immediately removes it. ### 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::ProjectApi.new project = 'project_example' # String | The Project ID or Project slug token_id = 'token_id_example' # String | The Token ID begin # Delete project API token api_instance.delete_project_api_key(project, token_id) rescue OryClient::ApiError => e puts "Error when calling ProjectApi->delete_project_api_key: #{e}" end ``` #### Using the delete_project_api_key_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > delete_project_api_key_with_http_info(project, token_id) ```ruby begin # Delete project API token data, status_code, headers = api_instance.delete_project_api_key_with_http_info(project, token_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling ProjectApi->delete_project_api_key_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project** | **String** | The Project ID or Project slug | | | **token_id** | **String** | The Token ID | | ### Return type nil (empty response body) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_active_project_in_console > get_active_project_in_console 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. ### 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::ProjectApi.new begin # Returns the Ory Network Project selected in the Ory Network Console result = api_instance.get_active_project_in_console p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_active_project_in_console: #{e}" end ``` #### Using the get_active_project_in_console_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_active_project_in_console_with_http_info ```ruby begin # Returns the Ory Network Project selected in the Ory Network Console data, status_code, headers = api_instance.get_active_project_in_console_with_http_info p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_active_project_in_console_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**ActiveProjectInConsole**](ActiveProjectInConsole.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **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::ProjectApi.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 ProjectApi->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 ProjectApi->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 ## get_project_members > > get_project_members(project) 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`. ### 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::ProjectApi.new project = 'project_example' # String | begin # Get all members associated with this project result = api_instance.get_project_members(project) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_project_members: #{e}" end ``` #### Using the get_project_members_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> get_project_members_with_http_info(project) ```ruby begin # Get all members associated with this project data, status_code, headers = api_instance.get_project_members_with_http_info(project) p status_code # => 2xx p headers # => { ... } p data # => > rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_project_members_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project** | **String** | | | ### Return type [**Array<CloudAccount>**](CloudAccount.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_project_metrics > get_project_metrics(project_id, event_type, resolution, from, to) Retrieves project metrics for the specified event type and time range ### 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID event_type = 'event_type_example' # String | The event type to query for resolution = 'resolution_example' # String | The resolution of the buckets The minimum resolution is 1 hour. from = Time.parse('2013-10-20T19:20:30+01:00') # Time | The start time of the time window to = Time.parse('2013-10-20T19:20:30+01:00') # Time | The end time of the time window begin result = api_instance.get_project_metrics(project_id, event_type, resolution, from, to) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_project_metrics: #{e}" end ``` #### Using the get_project_metrics_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_project_metrics_with_http_info(project_id, event_type, resolution, from, to) ```ruby begin data, status_code, headers = api_instance.get_project_metrics_with_http_info(project_id, event_type, resolution, from, to) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->get_project_metrics_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID | | | **event_type** | **String** | The event type to query for | | | **resolution** | **String** | The resolution of the buckets The minimum resolution is 1 hour. | | | **from** | **Time** | The start time of the time window | | | **to** | **Time** | The end time of the time window | | ### Return type [**GetProjectMetricsResponse**](GetProjectMetricsResponse.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_organizations > list_organizations(project_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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. begin result = api_instance.list_organizations(project_id) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->list_organizations: #{e}" end ``` #### Using the list_organizations_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> list_organizations_with_http_info(project_id) ```ruby begin data, status_code, headers = api_instance.list_organizations_with_http_info(project_id) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->list_organizations_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | ### Return type [**ListOrganizationsResponse**](ListOrganizationsResponse.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## list_project_api_keys > > list_project_api_keys(project) List a project's API Tokens A list of all the project's API tokens. ### 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::ProjectApi.new project = 'project_example' # String | The Project ID or Project slug begin # List a project's API Tokens result = api_instance.list_project_api_keys(project) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->list_project_api_keys: #{e}" end ``` #### Using the list_project_api_keys_with_http_info variant This returns an Array which contains the response data, status code and headers. > >, Integer, Hash)> list_project_api_keys_with_http_info(project) ```ruby begin # List a project's API Tokens data, status_code, headers = api_instance.list_project_api_keys_with_http_info(project) p status_code # => 2xx p headers # => { ... } p data # => > rescue OryClient::ApiError => e puts "Error when calling ProjectApi->list_project_api_keys_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project** | **String** | The Project ID or Project slug | | ### Return type [**Array<ProjectApiKey>**](ProjectApiKey.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::ProjectApi.new begin # List All Projects result = api_instance.list_projects p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->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 ProjectApi->list_projects_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**Array<ProjectMetadata>**](ProjectMetadata.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## patch_project > patch_project(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. ### 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. opts = { json_patch: [OryClient::JsonPatch.new({op: 'add', path: '/name'})] # Array | } begin # Patch an Ory Network Project Configuration result = api_instance.patch_project(project_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->patch_project: #{e}" end ``` #### Using the patch_project_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> patch_project_with_http_info(project_id, opts) ```ruby begin # Patch an Ory Network Project Configuration data, status_code, headers = api_instance.patch_project_with_http_info(project_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->patch_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **json_patch** | [**Array<JsonPatch>**](JsonPatch.md) | | [optional] | ### Return type [**SuccessfulProjectUpdate**](SuccessfulProjectUpdate.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## purge_project > purge_project(project_id) 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 !! ### 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. begin # Irrecoverably purge a project api_instance.purge_project(project_id) rescue OryClient::ApiError => e puts "Error when calling ProjectApi->purge_project: #{e}" end ``` #### Using the purge_project_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > purge_project_with_http_info(project_id) ```ruby begin # Irrecoverably purge a project data, status_code, headers = api_instance.purge_project_with_http_info(project_id) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling ProjectApi->purge_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | ### Return type nil (empty response body) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## remove_project_member > remove_project_member(project, member) 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`. ### 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::ProjectApi.new project = 'project_example' # String | member = 'member_example' # String | begin # Remove a member associated with this project api_instance.remove_project_member(project, member) rescue OryClient::ApiError => e puts "Error when calling ProjectApi->remove_project_member: #{e}" end ``` #### Using the remove_project_member_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > remove_project_member_with_http_info(project, member) ```ruby begin # Remove a member associated with this project data, status_code, headers = api_instance.remove_project_member_with_http_info(project, member) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling ProjectApi->remove_project_member_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project** | **String** | | | | **member** | **String** | | | ### Return type nil (empty response body) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## set_active_project_in_console > set_active_project_in_console(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. ### 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::ProjectApi.new opts = { set_active_project_in_console_body: OryClient::SetActiveProjectInConsoleBody.new({project_id: 'project_id_example'}) # SetActiveProjectInConsoleBody | } begin # Sets the Ory Network Project active in the Ory Network Console api_instance.set_active_project_in_console(opts) rescue OryClient::ApiError => e puts "Error when calling ProjectApi->set_active_project_in_console: #{e}" end ``` #### Using the set_active_project_in_console_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > set_active_project_in_console_with_http_info(opts) ```ruby begin # Sets the Ory Network Project active in the Ory Network Console data, status_code, headers = api_instance.set_active_project_in_console_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling ProjectApi->set_active_project_in_console_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **set_active_project_in_console_body** | [**SetActiveProjectInConsoleBody**](SetActiveProjectInConsoleBody.md) | | [optional] | ### Return type nil (empty response body) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## set_project > set_project(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! ### 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. opts = { set_project: OryClient::SetProject.new({cors_admin: OryClient::CORS.new({enabled: false, origins: ['origins_example']}), cors_public: OryClient::CORS.new({enabled: false, origins: ['origins_example']}), name: 'name_example', services: OryClient::ProjectServices.new}) # SetProject | } begin # Update an Ory Network Project Configuration result = api_instance.set_project(project_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->set_project: #{e}" end ``` #### Using the set_project_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> set_project_with_http_info(project_id, opts) ```ruby begin # Update an Ory Network Project Configuration data, status_code, headers = api_instance.set_project_with_http_info(project_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->set_project_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **set_project** | [**SetProject**](SetProject.md) | | [optional] | ### Return type [**SuccessfulProjectUpdate**](SuccessfulProjectUpdate.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ## update_organization > update_organization(project_id, organization_id, opts) Update a B2B SSO Organization 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::ProjectApi.new project_id = 'project_id_example' # String | Project ID The project's ID. organization_id = 'organization_id_example' # String | Organization ID The Organization's ID. opts = { organization_body: OryClient::OrganizationBody.new # OrganizationBody | } begin # Update a B2B SSO Organization for a project. result = api_instance.update_organization(project_id, organization_id, opts) p result rescue OryClient::ApiError => e puts "Error when calling ProjectApi->update_organization: #{e}" end ``` #### Using the update_organization_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> update_organization_with_http_info(project_id, organization_id, opts) ```ruby begin # Update a B2B SSO Organization for a project. data, status_code, headers = api_instance.update_organization_with_http_info(project_id, organization_id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling ProjectApi->update_organization_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **project_id** | **String** | Project ID The project's ID. | | | **organization_id** | **String** | Organization ID The Organization's ID. | | | **organization_body** | [**OrganizationBody**](OrganizationBody.md) | | [optional] | ### Return type [**Organization**](Organization.md) ### Authorization [oryAccessToken](../README.md#oryAccessToken) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json