# CloudsmithApi::OrgsApi All URIs are relative to *https://api.cloudsmith.io/v1* Method | HTTP request | Description ------------- | ------------- | ------------- [**orgs_list**](OrgsApi.md#orgs_list) | **GET** /orgs/ | Get a list of all the organizations you are associated with. [**orgs_members_list**](OrgsApi.md#orgs_members_list) | **GET** /orgs/{org}/members/ | Get the details for all organization members. [**orgs_members_read**](OrgsApi.md#orgs_members_read) | **GET** /orgs/{org}/members/{member}/ | Get the details for a specific organization member. [**orgs_members_remove**](OrgsApi.md#orgs_members_remove) | **GET** /orgs/{org}/members/{member}/remove/ | Removes a member from the organization. [**orgs_read**](OrgsApi.md#orgs_read) | **GET** /orgs/{org}/ | Get the details for the specific organization. # **orgs_list** > Array<Organization> orgs_list(opts) Get a list of all the organizations you are associated with. Get a list of all the organizations you are associated with. ### Example ```ruby # load the gem require 'cloudsmith-api' # setup authorization CloudsmithApi.configure do |config| # Configure API key authorization: apikey config.api_key['X-Api-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['X-Api-Key'] = 'Bearer' end api_instance = CloudsmithApi::OrgsApi.new opts = { page: 56, # Integer | A page number within the paginated result set. page_size: 56 # Integer | Number of results to return per page. } begin #Get a list of all the organizations you are associated with. result = api_instance.orgs_list(opts) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling OrgsApi->orgs_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **page** | **Integer**| A page number within the paginated result set. | [optional] **page_size** | **Integer**| Number of results to return per page. | [optional] ### Return type [**Array<Organization>**](Organization.md) ### Authorization [apikey](../README.md#apikey) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **orgs_members_list** > Array<OrganizationMembership> orgs_members_list(org, opts) Get the details for all organization members. Get the details for all organization members. ### Example ```ruby # load the gem require 'cloudsmith-api' # setup authorization CloudsmithApi.configure do |config| # Configure API key authorization: apikey config.api_key['X-Api-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['X-Api-Key'] = 'Bearer' end api_instance = CloudsmithApi::OrgsApi.new org = "org_example" # String | opts = { page: 56, # Integer | A page number within the paginated result set. page_size: 56 # Integer | Number of results to return per page. } begin #Get the details for all organization members. result = api_instance.orgs_members_list(org, opts) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling OrgsApi->orgs_members_list: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **String**| | **page** | **Integer**| A page number within the paginated result set. | [optional] **page_size** | **Integer**| Number of results to return per page. | [optional] ### Return type [**Array<OrganizationMembership>**](OrganizationMembership.md) ### Authorization [apikey](../README.md#apikey) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **orgs_members_read** > OrganizationMembership orgs_members_read(org, member) Get the details for a specific organization member. Get the details for a specific organization member. ### Example ```ruby # load the gem require 'cloudsmith-api' # setup authorization CloudsmithApi.configure do |config| # Configure API key authorization: apikey config.api_key['X-Api-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['X-Api-Key'] = 'Bearer' end api_instance = CloudsmithApi::OrgsApi.new org = "org_example" # String | member = "member_example" # String | begin #Get the details for a specific organization member. result = api_instance.orgs_members_read(org, member) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling OrgsApi->orgs_members_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **String**| | **member** | **String**| | ### Return type [**OrganizationMembership**](OrganizationMembership.md) ### Authorization [apikey](../README.md#apikey) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **orgs_members_remove** > OrganizationMembership orgs_members_remove(org, member) Removes a member from the organization. Removes a member from the organization. ### Example ```ruby # load the gem require 'cloudsmith-api' # setup authorization CloudsmithApi.configure do |config| # Configure API key authorization: apikey config.api_key['X-Api-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['X-Api-Key'] = 'Bearer' end api_instance = CloudsmithApi::OrgsApi.new org = "org_example" # String | member = "member_example" # String | begin #Removes a member from the organization. result = api_instance.orgs_members_remove(org, member) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling OrgsApi->orgs_members_remove: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **String**| | **member** | **String**| | ### Return type [**OrganizationMembership**](OrganizationMembership.md) ### Authorization [apikey](../README.md#apikey) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined # **orgs_read** > Organization orgs_read(org) Get the details for the specific organization. Get the details for the specific organization. ### Example ```ruby # load the gem require 'cloudsmith-api' # setup authorization CloudsmithApi.configure do |config| # Configure API key authorization: apikey config.api_key['X-Api-Key'] = 'YOUR API KEY' # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) #config.api_key_prefix['X-Api-Key'] = 'Bearer' end api_instance = CloudsmithApi::OrgsApi.new org = "org_example" # String | begin #Get the details for the specific organization. result = api_instance.orgs_read(org) p result rescue CloudsmithApi::ApiError => e puts "Exception when calling OrgsApi->orgs_read: #{e}" end ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **org** | **String**| | ### Return type [**Organization**](Organization.md) ### Authorization [apikey](../README.md#apikey) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined