Skip to content

PermissionsApi.md

Latest commit

 

History

History
363 lines (251 loc) · 11.4 KB

PermissionsApi.md

File metadata and controls

363 lines (251 loc) · 11.4 KB

stratum.PermissionsApi

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

Method HTTP request Description
create_permission POST /api/v1/tenants/{id}/permissions Create permission policy
delete_permission DELETE /api/v1/tenants/{id}/permissions/{policyId} Delete permission policy
resolve_permissions GET /api/v1/tenants/{id}/permissions Get resolved permissions
update_permission PATCH /api/v1/tenants/{id}/permissions/{policyId} Update permission policy

create_permission

PermissionPolicy create_permission(id, create_permission_input)

Create permission policy

Create a new permission policy for a tenant.

Example

  • Api Key Authentication (apiKey):
  • Bearer (JWT) Authentication (bearerAuth):
import stratum
from stratum.models.create_permission_input import CreatePermissionInput
from stratum.models.permission_policy import PermissionPolicy
from stratum.rest import ApiException
from pprint import pprint

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

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.PermissionsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    create_permission_input = stratum.CreatePermissionInput() # CreatePermissionInput | 

    try:
        # Create permission policy
        api_response = api_instance.create_permission(id, create_permission_input)
        print("The response of PermissionsApi->create_permission:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PermissionsApi->create_permission: %s\n" % e)

Parameters

Name Type Description Notes
id UUID
create_permission_input CreatePermissionInput

Return type

PermissionPolicy

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
201 Created permission policy -
400 Validation error -

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

delete_permission

delete_permission(id, policy_id)

Delete permission policy

Delete a permission policy.

Example

  • Api Key Authentication (apiKey):
  • Bearer (JWT) Authentication (bearerAuth):
import stratum
from stratum.rest import ApiException
from pprint import pprint

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

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.PermissionsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    policy_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Delete permission policy
        api_instance.delete_permission(id, policy_id)
    except Exception as e:
        print("Exception when calling PermissionsApi->delete_permission: %s\n" % e)

Parameters

Name Type Description Notes
id UUID
policy_id UUID

Return type

void (empty response body)

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
204 Permission policy deleted -
404 Tenant or policy not found -

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

resolve_permissions

List[PermissionPolicy] resolve_permissions(id)

Get resolved permissions

Get the resolved (inherited) permission policies for a tenant.

Example

  • Api Key Authentication (apiKey):
  • Bearer (JWT) Authentication (bearerAuth):
import stratum
from stratum.models.permission_policy import PermissionPolicy
from stratum.rest import ApiException
from pprint import pprint

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

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.PermissionsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 

    try:
        # Get resolved permissions
        api_response = api_instance.resolve_permissions(id)
        print("The response of PermissionsApi->resolve_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PermissionsApi->resolve_permissions: %s\n" % e)

Parameters

Name Type Description Notes
id UUID

Return type

List[PermissionPolicy]

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Resolved permission policies -
404 Tenant not found -

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

update_permission

PermissionPolicy update_permission(id, policy_id, update_permission_input)

Update permission policy

Update an existing permission policy.

Example

  • Api Key Authentication (apiKey):
  • Bearer (JWT) Authentication (bearerAuth):
import stratum
from stratum.models.permission_policy import PermissionPolicy
from stratum.models.update_permission_input import UpdatePermissionInput
from stratum.rest import ApiException
from pprint import pprint

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

# 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.

# Configure API key authorization: apiKey
configuration.api_key['apiKey'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['apiKey'] = 'Bearer'

# Configure Bearer authorization (JWT): bearerAuth
configuration = stratum.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with stratum.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = stratum.PermissionsApi(api_client)
    id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    policy_id = UUID('38400000-8cf0-11bd-b23e-10b96e4ef00d') # UUID | 
    update_permission_input = stratum.UpdatePermissionInput() # UpdatePermissionInput | 

    try:
        # Update permission policy
        api_response = api_instance.update_permission(id, policy_id, update_permission_input)
        print("The response of PermissionsApi->update_permission:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PermissionsApi->update_permission: %s\n" % e)

Parameters

Name Type Description Notes
id UUID
policy_id UUID
update_permission_input UpdatePermissionInput

Return type

PermissionPolicy

Authorization

apiKey, bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

HTTP response details

Status code Description Response headers
200 Updated permission policy -
404 Tenant or policy not found -

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