OrgsApi.md

unity_cloud_build_api.OrgsApi

All URIs are relative to /api/v1

Method	HTTP request	Description
get_billing_plans	GET /orgs/{orgid}/billingplan	Get billing plan
get_ssh_key_for_org	GET /orgs/{orgid}/sshkey	Get SSH Key
regenerate_ssh_key	POST /orgs/{orgid}/sshkey	Regenerate SSH Key

get_billing_plans

object get_billing_plans(orgid)

Get billing plan

Get the billing plan for the specified organization

Example

from __future__ import print_function
import time
import unity_cloud_build_api
from unity_cloud_build_api.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: apikey
configuration = unity_cloud_build_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
configuration = unity_cloud_build_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = unity_cloud_build_api.OrgsApi(unity_cloud_build_api.ApiClient(configuration))
orgid = 'orgid_example' # str | Organization identifier

try:
    # Get billing plan
    api_response = api_instance.get_billing_plans(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgsApi->get_billing_plans: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier

Return type

object

Authorization

apikey, permissions

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain, text/html, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_ssh_key_for_org

object get_ssh_key_for_org(orgid)

Get SSH Key

Get the ssh public key for the specified org

Example

from __future__ import print_function
import time
import unity_cloud_build_api
from unity_cloud_build_api.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: apikey
configuration = unity_cloud_build_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
configuration = unity_cloud_build_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = unity_cloud_build_api.OrgsApi(unity_cloud_build_api.ApiClient(configuration))
orgid = 'orgid_example' # str | Organization identifier

try:
    # Get SSH Key
    api_response = api_instance.get_ssh_key_for_org(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgsApi->get_ssh_key_for_org: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier

Return type

object

Authorization

apikey, permissions

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain, text/html, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

regenerate_ssh_key

object regenerate_ssh_key(orgid)

Regenerate SSH Key

Regenerate the ssh key for the specified org WARNING this is a destructive operation that will permanently remove your current SSH key.

Example

from __future__ import print_function
import time
import unity_cloud_build_api
from unity_cloud_build_api.rest import ApiException
from pprint import pprint
# Configure HTTP basic authorization: apikey
configuration = unity_cloud_build_api.Configuration()
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Configure OAuth2 access token for authorization: permissions
configuration = unity_cloud_build_api.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = unity_cloud_build_api.OrgsApi(unity_cloud_build_api.ApiClient(configuration))
orgid = 'orgid_example' # str | Organization identifier

try:
    # Regenerate SSH Key
    api_response = api_instance.regenerate_ssh_key(orgid)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling OrgsApi->regenerate_ssh_key: %s\n" % e)

Parameters

Name	Type	Description	Notes
orgid	str	Organization identifier

Return type

object

Authorization

apikey, permissions

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, text/plain, text/html, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]