cosmotech_api.OrganizationApi

All URIs are relative to http://localhost:8080

Method	HTTP request	Description
create_organization	POST /organizations	Create a new organization
create_organization_access_control	POST /organizations/{organization_id}/security/access	Add a control access to the Organization
delete_organization	DELETE /organizations/{organization_id}	Delete an organization
delete_organization_access_control	DELETE /organizations/{organization_id}/security/access/{identity_id}	Remove the specified access from the given Organization
get_organization	GET /organizations/{organization_id}	Get the details of an Organization
get_organization_access_control	GET /organizations/{organization_id}/security/access/{identity_id}	Get a control access for the Organization
get_organization_permissions	GET /organizations/{organization_id}/permissions/{role}	Get the Organization permissions by given role
get_organization_security	GET /organizations/{organization_id}/security	Get the Organization security information
list_organization_security_users	GET /organizations/{organization_id}/security/users	Get the Organization security users list
list_organizations	GET /organizations	List all Organizations
list_permissions	GET /organizations/permissions	Get all permissions per components
update_organization	PATCH /organizations/{organization_id}	Update an Organization
update_organization_access_control	PATCH /organizations/{organization_id}/security/access/{identity_id}	Update the specified access to User for an Organization
update_organization_default_security	PATCH /organizations/{organization_id}/security/default	Update the Organization default security

create_organization

Organization create_organization(organization_create_request)

Create a new organization

Create a new organization.

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization import Organization
from cosmotech_api.models.organization_create_request import OrganizationCreateRequest
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_create_request = cosmotech_api.OrganizationCreateRequest() # OrganizationCreateRequest | 

    try:
        # Create a new organization
        api_response = api_instance.create_organization(organization_create_request)
        print("The response of OrganizationApi->create_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->create_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_create_request	OrganizationCreateRequest

Return type

Organization

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	The Organization details	-
400	Bad request	-

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

create_organization_access_control

OrganizationAccessControl create_organization_access_control(organization_id, organization_access_control)

Add a control access to the Organization

Grant access to an organization for a user or group.

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization_access_control import OrganizationAccessControl
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    organization_access_control = cosmotech_api.OrganizationAccessControl() # OrganizationAccessControl | The new Organization security access to add.

    try:
        # Add a control access to the Organization
        api_response = api_instance.create_organization_access_control(organization_id, organization_access_control)
        print("The response of OrganizationApi->create_organization_access_control:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->create_organization_access_control: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
organization_access_control	OrganizationAccessControl	The new Organization security access to add.

Return type

OrganizationAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	The Organization access	-
404	The Organization specified is unknown or you don't have access to it	-

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

delete_organization

delete_organization(organization_id)

Delete an organization

Permanently delete an organization. This operation cannot be undone.

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier

    try:
        # Delete an organization
        api_instance.delete_organization(organization_id)
    except Exception as e:
        print("Exception when calling OrganizationApi->delete_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Request succeeded	-
404	The Organization specified is unknown or you don't have access to it	-

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

delete_organization_access_control

delete_organization_access_control(organization_id, identity_id)

Remove the specified access from the given Organization

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    identity_id = 'identity_id_example' # str | The User identifier

    try:
        # Remove the specified access from the given Organization
        api_instance.delete_organization_access_control(organization_id, identity_id)
    except Exception as e:
        print("Exception when calling OrganizationApi->delete_organization_access_control: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
identity_id	str	The User identifier

Return type

void (empty response body)

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
204	Request succeeded	-
404	The Organization or the user specified is unknown or you don't have access to them	-

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

get_organization

Organization get_organization(organization_id)

Get the details of an Organization

Retrieve detailed information about an organization.

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization import Organization
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier

    try:
        # Get the details of an Organization
        api_response = api_instance.get_organization(organization_id)
        print("The response of OrganizationApi->get_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->get_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier

Return type

Organization

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization details	-
404	The Organization specified is unknown or you don't have access to it	-

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

get_organization_access_control

OrganizationAccessControl get_organization_access_control(organization_id, identity_id)

Get a control access for the Organization

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization_access_control import OrganizationAccessControl
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    identity_id = 'identity_id_example' # str | The User identifier

    try:
        # Get a control access for the Organization
        api_response = api_instance.get_organization_access_control(organization_id, identity_id)
        print("The response of OrganizationApi->get_organization_access_control:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->get_organization_access_control: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
identity_id	str	The User identifier

Return type

OrganizationAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization access	-
404	The Organization or user specified is unknown or you don't have access to it	-

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

get_organization_permissions

List[str] get_organization_permissions(organization_id, role)

Get the Organization permissions by given role

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    role = 'role_example' # str | The Role

    try:
        # Get the Organization permissions by given role
        api_response = api_instance.get_organization_permissions(organization_id, role)
        print("The response of OrganizationApi->get_organization_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->get_organization_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
role	str	The Role

Return type

List[str]

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization security permission list	-

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

get_organization_security

OrganizationSecurity get_organization_security(organization_id)

Get the Organization security information

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization_security import OrganizationSecurity
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier

    try:
        # Get the Organization security information
        api_response = api_instance.get_organization_security(organization_id)
        print("The response of OrganizationApi->get_organization_security:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->get_organization_security: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier

Return type

OrganizationSecurity

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization security	-
404	The Organization specified is unknown or you don't have access to it	-

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

list_organization_security_users

List[str] list_organization_security_users(organization_id)

Get the Organization security users list

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier

    try:
        # Get the Organization security users list
        api_response = api_instance.list_organization_security_users(organization_id)
        print("The response of OrganizationApi->list_organization_security_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->list_organization_security_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier

Return type

List[str]

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization security users list	-
404	The Organization specified is unknown or you don't have access to it	-

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

list_organizations

List[Organization] list_organizations(page=page, size=size)

List all Organizations

Retrieve a paginated list of all organizations the authenticated user has permission to view. Use 'page' and 'size' query parameters for pagination.

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization import Organization
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    page = 56 # int | Page number to query (first page is at index 0) (optional)
    size = 56 # int | Amount of result by page (optional)

    try:
        # List all Organizations
        api_response = api_instance.list_organizations(page=page, size=size)
        print("The response of OrganizationApi->list_organizations:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->list_organizations: %s\n" % e)

Parameters

Name	Type	Description	Notes
page	int	Page number to query (first page is at index 0)	[optional]
size	int	Amount of result by page	[optional]

Return type

List[Organization]

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The list of Organizations	-

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

list_permissions

List[ComponentRolePermissions] list_permissions()

Get all permissions per components

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.component_role_permissions import ComponentRolePermissions
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)

    try:
        # Get all permissions per components
        api_response = api_instance.list_permissions()
        print("The response of OrganizationApi->list_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->list_permissions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

List[ComponentRolePermissions]

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: Not defined
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The security permission list	-

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

update_organization

Organization update_organization(organization_id, organization_update_request)

Update an Organization

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization import Organization
from cosmotech_api.models.organization_update_request import OrganizationUpdateRequest
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    organization_update_request = cosmotech_api.OrganizationUpdateRequest() # OrganizationUpdateRequest | The new Organization details. This endpoint can't be used to update security

    try:
        # Update an Organization
        api_response = api_instance.update_organization(organization_id, organization_update_request)
        print("The response of OrganizationApi->update_organization:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->update_organization: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
organization_update_request	OrganizationUpdateRequest	The new Organization details. This endpoint can't be used to update security

Return type

Organization

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The organization details	-
400	Bad request	-
404	The Organization specified is unknown or you don't have access to it	-

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

update_organization_access_control

OrganizationAccessControl update_organization_access_control(organization_id, identity_id, organization_role)

Update the specified access to User for an Organization

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization_access_control import OrganizationAccessControl
from cosmotech_api.models.organization_role import OrganizationRole
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    identity_id = 'identity_id_example' # str | The User identifier
    organization_role = cosmotech_api.OrganizationRole() # OrganizationRole | The new Organization Access Control

    try:
        # Update the specified access to User for an Organization
        api_response = api_instance.update_organization_access_control(organization_id, identity_id, organization_role)
        print("The response of OrganizationApi->update_organization_access_control:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->update_organization_access_control: %s\n" % e)

Parameters

Name	Type	Description
organization_id	str	The Organization identifier
identity_id	str	The User identifier
organization_role	OrganizationRole	The new Organization Access Control

Return type

OrganizationAccessControl

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
200	The Organization access	-
404	The Organization specified is unknown or you don't have access to it	-

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

update_organization_default_security

OrganizationSecurity update_organization_default_security(organization_id, organization_role)

Update the Organization default security

Example

OAuth Authentication (oAuth2AuthCode):

import cosmotech_api
from cosmotech_api.models.organization_role import OrganizationRole
from cosmotech_api.models.organization_security import OrganizationSecurity
from cosmotech_api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = cosmotech_api.Configuration(
    host = "http://localhost:8080"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]

# Enter a context with an instance of the API client
with cosmotech_api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cosmotech_api.OrganizationApi(api_client)
    organization_id = 'organization_id_example' # str | The Organization identifier
    organization_role = cosmotech_api.OrganizationRole() # OrganizationRole | This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.

    try:
        # Update the Organization default security
        api_response = api_instance.update_organization_default_security(organization_id, organization_role)
        print("The response of OrganizationApi->update_organization_default_security:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling OrganizationApi->update_organization_default_security: %s\n" % e)

Parameters

Name	Type	Description	Notes
organization_id	str	The Organization identifier
organization_role	OrganizationRole	This change the organization default security. The default security is the role assigned to any person not on the Access Control List. If the default security is None, then nobody outside of the ACL can access the organization.

Return type

OrganizationSecurity

Authorization

oAuth2AuthCode

HTTP request headers

Content-Type: application/json, application/yaml
Accept: application/json, application/yaml

HTTP response details

Status code	Description	Response headers
201	The Organization default visibility	-
404	The Organization specified is unknown or you don't have access to it	-

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

FilesExpand file tree

OrganizationApi.md

Latest commit

History

OrganizationApi.md

File metadata and controls

cosmotech_api.OrganizationApi

create_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_organization_access_control

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_organization_access_control

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_organization

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_organization_access_control

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_organization_permissions

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_organization_security

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_organization_security_users

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_organizations

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

list_permissions

Example

Parameters