opal_security.ResourcesApi

All URIs are relative to https://api.opal.dev/v1

Method	HTTP request	Description
add_resource_nhi	POST /resources/{resource_id}/non-human-identities/{non_human_identity_id}
add_resource_user	POST /resources/{resource_id}/users/{user_id}
create_resource	POST /resources
delete_resource	DELETE /resources/{resource_id}
delete_resource_nhi	DELETE /resources/{resource_id}/non-human-identities/{non_human_identity_id}
delete_resource_user	DELETE /resources/{resource_id}/users/{user_id}
get_resource	GET /resources/{resource_id}	Get resource by ID
get_resource_groups	GET /resources/{resource_id}/groups
get_resource_message_channels	GET /resources/{resource_id}/message-channels
get_resource_nhis	GET /resources/{resource_id}/non-human-identities
get_resource_reviewer_stages	GET /resources/{resource_id}/reviewer-stages
get_resource_reviewers	GET /resources/{resource_id}/reviewers
get_resource_scoped_role_permissions	GET /resources/{resource_id}/scoped-role-permissions
get_resource_tags	GET /resources/{resource_id}/tags
get_resource_user	GET /resources/{resource_id}/users/{user_id}	Get resource user
get_resource_users	GET /resources/{resource_id}/users	Get resource users
get_resource_visibility	GET /resources/{resource_id}/visibility
get_resources	GET /resources	Get resources
get_user_resources	GET /resources/users/{user_id}
resource_user_access_status_retrieve	GET /resource-user-access-status/{resource_id}/{user_id}
set_resource_message_channels	PUT /resources/{resource_id}/message-channels
set_resource_reviewer_stages	PUT /resources/{resource_id}/reviewer-stages
set_resource_reviewers	PUT /resources/{resource_id}/reviewers
set_resource_scoped_role_permissions	PUT /resources/{resource_id}/scoped-role-permissions
set_resource_visibility	PUT /resources/{resource_id}/visibility
update_resource_user	PUT /resources/{resource_id}/users/{user_id}
update_resources	PUT /resources

add_resource_nhi

ResourceNHI add_resource_nhi(resource_id, non_human_identity_id, add_resource_nhi_request=add_resource_nhi_request)

Gives a non-human identity access to this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.add_resource_nhi_request import AddResourceNhiRequest
from opal_security.models.resource_nhi import ResourceNHI
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    non_human_identity_id = UUID('f92aa855-cea9-4814-b9d8-f2a60d3e4a06') # UUID | The resource ID of the non-human identity to add.
    add_resource_nhi_request = opal_security.AddResourceNhiRequest() # AddResourceNhiRequest |  (optional)

    try:
        api_response = api_instance.add_resource_nhi(resource_id, non_human_identity_id, add_resource_nhi_request=add_resource_nhi_request)
        print("The response of ResourcesApi->add_resource_nhi:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->add_resource_nhi: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
non_human_identity_id	UUID	The resource ID of the non-human identity to add.
add_resource_nhi_request	AddResourceNhiRequest		[optional]

Return type

ResourceNHI

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Details about the access that the non-human identity was granted to the resource.	-

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

add_resource_user

ResourceUser add_resource_user(resource_id, user_id, duration_minutes=duration_minutes, access_level_remote_id=access_level_remote_id, add_resource_user_request=add_resource_user_request)

Adds a user to this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.add_resource_user_request import AddResourceUserRequest
from opal_security.models.resource_user import ResourceUser
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    user_id = UUID('f92aa855-cea9-4814-b9d8-f2a60d3e4a06') # UUID | The ID of the user to add.
    duration_minutes = 60 # int | The duration for which the resource can be accessed (in minutes). Use 0 to set to indefinite. (optional)
    access_level_remote_id = 'arn:aws:iam::590304332660:role/AdministratorAccess' # str | The remote ID of the access level to grant to this user. If omitted, the default access level remote ID value (empty string) is used. (optional)
    add_resource_user_request = opal_security.AddResourceUserRequest() # AddResourceUserRequest |  (optional)

    try:
        api_response = api_instance.add_resource_user(resource_id, user_id, duration_minutes=duration_minutes, access_level_remote_id=access_level_remote_id, add_resource_user_request=add_resource_user_request)
        print("The response of ResourcesApi->add_resource_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->add_resource_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
user_id	UUID	The ID of the user to add.
duration_minutes	int	The duration for which the resource can be accessed (in minutes). Use 0 to set to indefinite.	[optional]
access_level_remote_id	str	The remote ID of the access level to grant to this user. If omitted, the default access level remote ID value (empty string) is used.	[optional]
add_resource_user_request	AddResourceUserRequest		[optional]

Return type

ResourceUser

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The ResourceUser that was created.	-

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

create_resource

Resource create_resource(create_resource_info)

Creates a resource. See here for details about importing resources.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.create_resource_info import CreateResourceInfo
from opal_security.models.resource import Resource
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    create_resource_info = opal_security.CreateResourceInfo() # CreateResourceInfo | 

    try:
        api_response = api_instance.create_resource(create_resource_info)
        print("The response of ResourcesApi->create_resource:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->create_resource: %s\n" % e)

Parameters

Name	Type	Description	Notes
create_resource_info	CreateResourceInfo

Return type

Resource

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The resource just created.	-

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

delete_resource

delete_resource(resource_id)

Deletes a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        api_instance.delete_resource(resource_id)
    except Exception as e:
        print("Exception when calling ResourcesApi->delete_resource: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	The resource was successfully deleted.	-

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

delete_resource_nhi

delete_resource_nhi(resource_id, non_human_identity_id, access_level_remote_id=access_level_remote_id)

Removes a non-human identity's direct access from this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    non_human_identity_id = UUID('f92aa855-cea9-4814-b9d8-f2a60d3e4a06') # UUID | The resource ID of the non-human identity to remove from this resource.
    access_level_remote_id = 'roles/cloudsql.instanceUser' # str | The remote ID of the access level for which this non-human identity has direct access. If omitted, the default access level remote ID value (empty string) is assumed. (optional)

    try:
        api_instance.delete_resource_nhi(resource_id, non_human_identity_id, access_level_remote_id=access_level_remote_id)
    except Exception as e:
        print("Exception when calling ResourcesApi->delete_resource_nhi: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
non_human_identity_id	UUID	The resource ID of the non-human identity to remove from this resource.
access_level_remote_id	str	The remote ID of the access level for which this non-human identity has direct access. If omitted, the default access level remote ID value (empty string) is assumed.	[optional]

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	This non-human identity's access was successfully removed from this resource.	-

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

delete_resource_user

delete_resource_user(resource_id, user_id, access_level_remote_id=access_level_remote_id)

Removes a user's direct access from this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    user_id = UUID('f92aa855-cea9-4814-b9d8-f2a60d3e4a06') # UUID | The ID of a user to remove from this resource.
    access_level_remote_id = 'arn:aws:iam::590304332660:role/AdministratorAccess' # str | The remote ID of the access level for which this user has direct access. If omitted, the default access level remote ID value (empty string) is assumed. (optional)

    try:
        api_instance.delete_resource_user(resource_id, user_id, access_level_remote_id=access_level_remote_id)
    except Exception as e:
        print("Exception when calling ResourcesApi->delete_resource_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
user_id	UUID	The ID of a user to remove from this resource.
access_level_remote_id	str	The remote ID of the access level for which this user has direct access. If omitted, the default access level remote ID value (empty string) is assumed.	[optional]

Return type

void (empty response body)

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

HTTP response details

Status code	Description	Response headers
200	This user's access was successfully removed from this resource.	-

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

get_resource

Resource get_resource(resource_id)

Get resource by ID

Retrieves a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.resource import Resource
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        # Get resource by ID
        api_response = api_instance.get_resource(resource_id)
        print("The response of ResourcesApi->get_resource:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

Resource

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The requested resource.	-

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

get_resource_groups

GroupResourceList get_resource_groups(resource_id)

Returns a list of groups that grant access to the resource

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.group_resource_list import GroupResourceList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('1b978423-db0a-4037-a4cf-f79c60cb67b3') # UUID | The ID of the resource that the groups grant access to.

    try:
        api_response = api_instance.get_resource_groups(resource_id)
        print("The response of ResourcesApi->get_resource_groups:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource that the groups grant access to.

Return type

GroupResourceList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The groups that grant access to the resource.	-

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

get_resource_message_channels

MessageChannelList get_resource_message_channels(resource_id)

Gets the list of audit message channels attached to a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.message_channel_list import MessageChannelList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        api_response = api_instance.get_resource_message_channels(resource_id)
        print("The response of ResourcesApi->get_resource_message_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_message_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

MessageChannelList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The audit message channels attached to the resource.	-

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

get_resource_nhis

AccessList get_resource_nhis(resource_id, limit=limit)

Gets the list of non-human identities with access to this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.access_list import AccessList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    limit = 200 # int | Limit the number of results returned. (optional)

    try:
        api_response = api_instance.get_resource_nhis(resource_id, limit=limit)
        print("The response of ResourcesApi->get_resource_nhis:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_nhis: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
limit	int	Limit the number of results returned.	[optional]

Return type

AccessList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of non-human identities with access to this resource.	-

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

get_resource_reviewer_stages

List[ReviewerStage] get_resource_reviewer_stages(resource_id)

Gets the list reviewer stages for a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.reviewer_stage import ReviewerStage
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        api_response = api_instance.get_resource_reviewer_stages(resource_id)
        print("The response of ResourcesApi->get_resource_reviewer_stages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_reviewer_stages: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

List[ReviewerStage]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The reviewer stages for this resource.	-

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

get_resource_reviewers

List[UUID] get_resource_reviewers(resource_id)

Gets the list of owner IDs of the reviewers for a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        api_response = api_instance.get_resource_reviewers(resource_id)
        print("The response of ResourcesApi->get_resource_reviewers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_reviewers: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

List[UUID]

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The IDs of owners that are reviewers for this resource.	-

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

get_resource_scoped_role_permissions

ScopedRolePermissionList get_resource_scoped_role_permissions(resource_id)

Returns all the scoped role permissions that apply to the given resource. Only OPAL_SCOPED_ROLE resource type supports this field.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.scoped_role_permission_list import ScopedRolePermissionList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('1b978423-db0a-4037-a4cf-f79c60cb67b3') # UUID | The ID of the resource whose scoped role permissions belong to.

    try:
        api_response = api_instance.get_resource_scoped_role_permissions(resource_id)
        print("The response of ResourcesApi->get_resource_scoped_role_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_scoped_role_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource whose scoped role permissions belong to.

Return type

ScopedRolePermissionList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The role permissions that this Opal Scoped Role has.	-

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

get_resource_tags

TagsList get_resource_tags(resource_id)

Returns all tags applied to the resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.tags_list import TagsList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('1b978423-db0a-4037-a4cf-f79c60cb67b3') # UUID | The ID of the resource whose tags to return.

    try:
        api_response = api_instance.get_resource_tags(resource_id)
        print("The response of ResourcesApi->get_resource_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_tags: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource whose tags to return.

Return type

TagsList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The tags applied to the resource.	-

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

get_resource_user

GetResourceUser200Response get_resource_user(resource_id, user_id, cursor=cursor)

Get resource user

Returns information about a specific user's access to a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.get_resource_user200_response import GetResourceUser200Response
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('32acc112-21ff-4669-91c2-21e27683eaa1') # UUID | The ID of the resource.
    user_id = UUID('29827fb8-f2dd-4e80-9576-28e31e9934ac') # UUID | The ID of the user.
    cursor = 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw' # str | The pagination cursor value. (optional)

    try:
        # Get resource user
        api_response = api_instance.get_resource_user(resource_id, user_id, cursor=cursor)
        print("The response of ResourcesApi->get_resource_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_user: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
user_id	UUID	The ID of the user.
cursor	str	The pagination cursor value.	[optional]

Return type

GetResourceUser200Response

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of ResourceUser records for the user's access to the resource.	-
404	Resource or user not found.	-

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

get_resource_users

ResourceAccessUserList get_resource_users(resource_id, limit=limit)

Get resource users

Gets the list of users for this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.resource_access_user_list import ResourceAccessUserList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    limit = 200 # int | Limit the number of results returned. (optional)

    try:
        # Get resource users
        api_response = api_instance.get_resource_users(resource_id, limit=limit)
        print("The response of ResourcesApi->get_resource_users:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_users: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
limit	int	Limit the number of results returned.	[optional]

Return type

ResourceAccessUserList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of users with access to this resource.	-

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

get_resource_visibility

VisibilityInfo get_resource_visibility(resource_id)

Gets the visibility of this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.visibility_info import VisibilityInfo
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.

    try:
        api_response = api_instance.get_resource_visibility(resource_id)
        print("The response of ResourcesApi->get_resource_visibility:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resource_visibility: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.

Return type

VisibilityInfo

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The visibility info of this resource.	-

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

get_resources

PaginatedResourcesList get_resources(cursor=cursor, page_size=page_size, resource_type_filter=resource_type_filter, resource_ids=resource_ids, resource_name=resource_name, parent_resource_id=parent_resource_id, ancestor_resource_id=ancestor_resource_id, remote_id=remote_id)

Get resources

Returns a list of resources for your organization.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.paginated_resources_list import PaginatedResourcesList
from opal_security.models.resource_type_enum import ResourceTypeEnum
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    cursor = 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw' # str | The pagination cursor value. (optional)
    page_size = 200 # int | Number of results to return per page. Default is 200. (optional)
    resource_type_filter = opal_security.ResourceTypeEnum() # ResourceTypeEnum | The resource type to filter by. Required when remote_id is provided. (optional)
    resource_ids = [["4baf8423-db0a-4037-a4cf-f79c60cb67a5","1b978423-db0a-4037-a4cf-f79c60cb67b3"]] # List[UUID] | The resource ids to filter by. (optional)
    resource_name = 'example-name' # str | Resource name. (optional)
    parent_resource_id = UUID('[\"4baf8423-db0a-4037-a4cf-f79c60cb67a5\"]') # UUID | The parent resource id to filter by. (optional)
    ancestor_resource_id = UUID('[\"4baf8423-db0a-4037-a4cf-f79c60cb67a5\"]') # UUID | The ancestor resource id to filter by. Returns all resources that are descendants of the specified resource. (optional)
    remote_id = 'remote_id_example' # str | Filter resources by their remote id. This will return all resources that have a remote id that matches the provided remote id. Note that this requires resource_type_filter to be provided. (optional)

    try:
        # Get resources
        api_response = api_instance.get_resources(cursor=cursor, page_size=page_size, resource_type_filter=resource_type_filter, resource_ids=resource_ids, resource_name=resource_name, parent_resource_id=parent_resource_id, ancestor_resource_id=ancestor_resource_id, remote_id=remote_id)
        print("The response of ResourcesApi->get_resources:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_resources: %s\n" % e)

Parameters

Name	Type	Description	Notes
cursor	str	The pagination cursor value.	[optional]
page_size	int	Number of results to return per page. Default is 200.	[optional]
resource_type_filter	ResourceTypeEnum	The resource type to filter by. Required when remote_id is provided.	[optional]
resource_ids	List[UUID]	The resource ids to filter by.	[optional]
resource_name	str	Resource name.	[optional]
parent_resource_id	UUID	The parent resource id to filter by.	[optional]
ancestor_resource_id	UUID	The ancestor resource id to filter by. Returns all resources that are descendants of the specified resource.	[optional]
remote_id	str	Filter resources by their remote id. This will return all resources that have a remote id that matches the provided remote id. Note that this requires resource_type_filter to be provided.	[optional]

Return type

PaginatedResourcesList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	One page worth resources associated with your organization.	-

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

get_user_resources

ResourceAccessUserList get_user_resources(user_id, limit=limit, cursor=cursor, include_unmanaged=include_unmanaged)

Gets the list of resources for this user.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.resource_access_user_list import ResourceAccessUserList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    user_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the user.
    limit = 200 # int | Limit the number of results returned. (optional)
    cursor = 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw' # str | The pagination cursor value. (optional)
    include_unmanaged = false # bool | Include user's access to unmanaged resources. (optional)

    try:
        api_response = api_instance.get_user_resources(user_id, limit=limit, cursor=cursor, include_unmanaged=include_unmanaged)
        print("The response of ResourcesApi->get_user_resources:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->get_user_resources: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_id	UUID	The ID of the user.
limit	int	Limit the number of results returned.	[optional]
cursor	str	The pagination cursor value.	[optional]
include_unmanaged	bool	Include user's access to unmanaged resources.	[optional]

Return type

ResourceAccessUserList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	List of resources user has access to.	-

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

resource_user_access_status_retrieve

ResourceUserAccessStatus resource_user_access_status_retrieve(resource_id, user_id, access_level_remote_id=access_level_remote_id, cursor=cursor, page_size=page_size)

Get user's access status to a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.resource_user_access_status import ResourceUserAccessStatus
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('1b978423-db0a-4037-a4cf-f79c60cb67b3') # UUID | The ID of the resource.
    user_id = UUID('29827fb8-f2dd-4e80-9576-28e31e9934ac') # UUID | The ID of the user.
    access_level_remote_id = 'arn:aws:iam::590304332660:role/AdministratorAccess' # str | The remote ID of the access level that you wish to query for the resource. If omitted, the default access level remote ID value (empty string) is used. (optional)
    cursor = 'cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw' # str | The pagination cursor value. (optional)
    page_size = 200 # int | Number of results to return per page. Default is 200. (optional)

    try:
        api_response = api_instance.resource_user_access_status_retrieve(resource_id, user_id, access_level_remote_id=access_level_remote_id, cursor=cursor, page_size=page_size)
        print("The response of ResourcesApi->resource_user_access_status_retrieve:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->resource_user_access_status_retrieve: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
user_id	UUID	The ID of the user.
access_level_remote_id	str	The remote ID of the access level that you wish to query for the resource. If omitted, the default access level remote ID value (empty string) is used.	[optional]
cursor	str	The pagination cursor value.	[optional]
page_size	int	Number of results to return per page. Default is 200.	[optional]

Return type

ResourceUserAccessStatus

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The access status reflecting the user's access to the resource.	-

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

set_resource_message_channels

List[UUID] set_resource_message_channels(resource_id, message_channel_id_list)

Sets the list of audit message channels attached to a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.message_channel_id_list import MessageChannelIDList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    message_channel_id_list = opal_security.MessageChannelIDList() # MessageChannelIDList | 

    try:
        api_response = api_instance.set_resource_message_channels(resource_id, message_channel_id_list)
        print("The response of ResourcesApi->set_resource_message_channels:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->set_resource_message_channels: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
message_channel_id_list	MessageChannelIDList

Return type

List[UUID]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated audit message channel IDs for the resource.	-

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

set_resource_reviewer_stages

List[ReviewerStage] set_resource_reviewer_stages(resource_id, reviewer_stage_list)

Sets the list of reviewer stages for a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.reviewer_stage import ReviewerStage
from opal_security.models.reviewer_stage_list import ReviewerStageList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    reviewer_stage_list = opal_security.ReviewerStageList() # ReviewerStageList | 

    try:
        api_response = api_instance.set_resource_reviewer_stages(resource_id, reviewer_stage_list)
        print("The response of ResourcesApi->set_resource_reviewer_stages:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->set_resource_reviewer_stages: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
reviewer_stage_list	ReviewerStageList

Return type

List[ReviewerStage]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated reviewer stages for this resource.	-

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

set_resource_reviewers

List[UUID] set_resource_reviewers(resource_id, reviewer_id_list)

Sets the list of reviewers for a resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.reviewer_id_list import ReviewerIDList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    reviewer_id_list = opal_security.ReviewerIDList() # ReviewerIDList | 

    try:
        api_response = api_instance.set_resource_reviewers(resource_id, reviewer_id_list)
        print("The response of ResourcesApi->set_resource_reviewers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->set_resource_reviewers: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
reviewer_id_list	ReviewerIDList

Return type

List[UUID]

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The updated IDs of owners that are reviewers for this resource	-

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

set_resource_scoped_role_permissions

ScopedRolePermissionList set_resource_scoped_role_permissions(resource_id, scoped_role_permission_list)

Sets all the scoped role permissions on an OPAL_SCOPED_ROLE resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.scoped_role_permission_list import ScopedRolePermissionList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('1b978423-db0a-4037-a4cf-f79c60cb67b3') # UUID | The ID of the resource whose scoped role permissions belong to. Must be of OPAL_SCOPED_ROLE resource type.
    scoped_role_permission_list = opal_security.ScopedRolePermissionList() # ScopedRolePermissionList | 

    try:
        api_response = api_instance.set_resource_scoped_role_permissions(resource_id, scoped_role_permission_list)
        print("The response of ResourcesApi->set_resource_scoped_role_permissions:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->set_resource_scoped_role_permissions: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource whose scoped role permissions belong to. Must be of OPAL_SCOPED_ROLE resource type.
scoped_role_permission_list	ScopedRolePermissionList

Return type

ScopedRolePermissionList

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The role permissions that this Opal Scoped Role has.	-

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

set_resource_visibility

VisibilityInfo set_resource_visibility(resource_id, visibility_info)

Sets the visibility of this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.visibility_info import VisibilityInfo
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    visibility_info = opal_security.VisibilityInfo() # VisibilityInfo | 

    try:
        api_response = api_instance.set_resource_visibility(resource_id, visibility_info)
        print("The response of ResourcesApi->set_resource_visibility:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->set_resource_visibility: %s\n" % e)

Parameters

Name	Type	Description	Notes
resource_id	UUID	The ID of the resource.
visibility_info	VisibilityInfo

Return type

VisibilityInfo

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The visibility info of this resource.	-

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

update_resource_user

ResourceUser update_resource_user(resource_id, user_id, update_resource_user_request)

Updates a user's access level or duration on this resource.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.resource_user import ResourceUser
from opal_security.models.update_resource_user_request import UpdateResourceUserRequest
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    resource_id = UUID('4baf8423-db0a-4037-a4cf-f79c60cb67a5') # UUID | The ID of the resource.
    user_id = UUID('f92aa855-cea9-4814-b9d8-f2a60d3e4a06') # UUID | The ID of the user whose access is being updated.
    update_resource_user_request = opal_security.UpdateResourceUserRequest() # UpdateResourceUserRequest | 

    try:
        api_response = api_instance.update_resource_user(resource_id, user_id, update_resource_user_request)
        print("The response of ResourcesApi->update_resource_user:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->update_resource_user: %s\n" % e)

Parameters

Name	Type	Description
resource_id	UUID	The ID of the resource.
user_id	UUID	The ID of the user whose access is being updated.
update_resource_user_request	UpdateResourceUserRequest

Return type

ResourceUser

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The ResourceUser was successfully updated.	-

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

update_resources

UpdateResourceInfoList update_resources(update_resource_info_list)

Bulk updates a list of resources.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.update_resource_info_list import UpdateResourceInfoList
from opal_security.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.opal.dev/v1
# See configuration.py for a list of all supported configuration parameters.
import opal_security as opal

configuration = opal.Configuration(
    host = "https://api.opal.dev/v1"
)

# 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 Bearer authorization: BearerAuth
configuration = opal.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Enter a context with an instance of the API client
with opal_security.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = opal_security.ResourcesApi(api_client)
    update_resource_info_list = opal_security.UpdateResourceInfoList() # UpdateResourceInfoList | Resources to be updated

    try:
        api_response = api_instance.update_resources(update_resource_info_list)
        print("The response of ResourcesApi->update_resources:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling ResourcesApi->update_resources: %s\n" % e)

Parameters

Name	Type	Description	Notes
update_resource_info_list	UpdateResourceInfoList	Resources to be updated

Return type

UpdateResourceInfoList

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	The resulting updated resource infos.	-

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

FilesExpand file tree

ResourcesApi.md

Latest commit

History

ResourcesApi.md

File metadata and controls

opal_security.ResourcesApi

add_resource_nhi

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_resource_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_resource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_resource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_resource_nhi

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_resource_user

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_resource

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_resource_groups

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_resource_message_channels

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_resource_nhis

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_resource_reviewer_stages

Example

Parameters