opal_security.TagsApi

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

Method	HTTP request	Description
add_group_tag	POST /tags/{tag_id}/groups/{group_id}
add_resource_tag	POST /tags/{tag_id}/resources/{resource_id}
add_user_tag	POST /tags/{tag_id}/users/{user_id}
create_tag	POST /tag
delete_tag_by_id	DELETE /tag/{tag_id}
get_tag	GET /tag
get_tag_by_id	GET /tag/{tag_id}
get_tags	GET /tags
remove_group_tag	DELETE /tags/{tag_id}/groups/{group_id}
remove_resource_tag	DELETE /tags/{tag_id}/resources/{resource_id}
remove_user_tag	DELETE /tags/{tag_id}/users/{user_id}

add_group_tag

add_group_tag(tag_id, group_id)

Applies a tag to a group.

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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to apply.
    group_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the group to apply the tag to.

    try:
        api_instance.add_group_tag(tag_id, group_id)
    except Exception as e:
        print("Exception when calling TagsApi->add_group_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to apply.
group_id	str	The ID of the group to apply the tag to.

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	Tag applied to group successfully.	-

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

add_resource_tag

add_resource_tag(tag_id, resource_id)

Applies a tag to 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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to apply.
    resource_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the resource to apply the tag to.

    try:
        api_instance.add_resource_tag(tag_id, resource_id)
    except Exception as e:
        print("Exception when calling TagsApi->add_resource_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to apply.
resource_id	str	The ID of the resource to apply the tag to.

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	Tag applied to resource successfully.	-

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

add_user_tag

add_user_tag(tag_id, user_id)

Applies a tag to a user.

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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to apply.
    user_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the user to apply the tag to.

    try:
        api_instance.add_user_tag(tag_id, user_id)
    except Exception as e:
        print("Exception when calling TagsApi->add_user_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to apply.
user_id	str	The ID of the user to apply the tag to.

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	Tag applied to user successfully.	-

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

create_tag

Tag create_tag(tag_key=tag_key, tag_value=tag_value, admin_owner_id=admin_owner_id, create_tag_info=create_tag_info)

Creates a tag with the given key and value.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.create_tag_info import CreateTagInfo
from opal_security.models.tag import Tag
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.TagsApi(api_client)
    tag_key = 'api-scope' # str | The key of the tag to create. (optional)
    tag_value = 'production' # str | The value of the tag to create. (optional)
    admin_owner_id = 'f92aa855-cea9-4814-b9d8-f2a60d3e4a06' # str | The ID of the owner that manages the tag. (optional)
    create_tag_info = opal_security.CreateTagInfo() # CreateTagInfo |  (optional)

    try:
        api_response = api_instance.create_tag(tag_key=tag_key, tag_value=tag_value, admin_owner_id=admin_owner_id, create_tag_info=create_tag_info)
        print("The response of TagsApi->create_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TagsApi->create_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_key	str	The key of the tag to create.	[optional]
tag_value	str	The value of the tag to create.	[optional]
admin_owner_id	str	The ID of the owner that manages the tag.	[optional]
create_tag_info	CreateTagInfo		[optional]

Return type

Tag

Authorization

BearerAuth

HTTP request headers

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

HTTP response details

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

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

delete_tag_by_id

delete_tag_by_id(tag_id)

UNSTABLE. May be removed at any time. Deletes a tag with the given id.

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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The tag ID

    try:
        api_instance.delete_tag_by_id(tag_id)
    except Exception as e:
        print("Exception when calling TagsApi->delete_tag_by_id: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The tag ID

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	Tag was deleted.	-

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

get_tag

Tag get_tag(tag_key, tag_value=tag_value)

Gets a tag with the given key and value.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.tag import Tag
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.TagsApi(api_client)
    tag_key = 'api-scope' # str | The key of the tag to get.
    tag_value = 'production' # str | The value of the tag to get. (optional)

    try:
        api_response = api_instance.get_tag(tag_key, tag_value=tag_value)
        print("The response of TagsApi->get_tag:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TagsApi->get_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_key	str	The key of the tag to get.
tag_value	str	The value of the tag to get.	[optional]

Return type

Tag

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The tag requested.	-

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

get_tag_by_id

Tag get_tag_by_id(tag_id)

UNSTABLE. May be removed at any time. Gets a tag with the given id.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.tag import Tag
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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The tag ID

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

Parameters

Name	Type	Description	Notes
tag_id	str	The tag ID

Return type

Tag

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	The tag requested.	-

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

get_tags

PaginatedTagsList get_tags(cursor=cursor, page_size=page_size)

Returns a list of tags created by your organization.

Example

Bearer Authentication (BearerAuth):

import opal_security
from opal_security.models.paginated_tags_list import PaginatedTagsList
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.TagsApi(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)

    try:
        api_response = api_instance.get_tags(cursor=cursor, page_size=page_size)
        print("The response of TagsApi->get_tags:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TagsApi->get_tags: %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]

Return type

PaginatedTagsList

Authorization

BearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	A list of tags created by your organization.	-

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

remove_group_tag

remove_group_tag(tag_id, group_id)

Removes a tag from a group.

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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to remove.
    group_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the group to remove the tag from.

    try:
        api_instance.remove_group_tag(tag_id, group_id)
    except Exception as e:
        print("Exception when calling TagsApi->remove_group_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to remove.
group_id	str	The ID of the group to remove the tag from.

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	Tag removed from group successfully.	-

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

remove_resource_tag

remove_resource_tag(tag_id, resource_id)

Removes a tag from 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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to remove.
    resource_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the resource to remove the tag from.

    try:
        api_instance.remove_resource_tag(tag_id, resource_id)
    except Exception as e:
        print("Exception when calling TagsApi->remove_resource_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to remove.
resource_id	str	The ID of the resource to remove the tag from.

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	Tag removed from resource successfully.	-

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

remove_user_tag

remove_user_tag(tag_id, user_id)

Removes a tag from a user.

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.TagsApi(api_client)
    tag_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the tag to remove.
    user_id = '1b978423-db0a-4037-a4cf-f79c60cb67b3' # str | The ID of the user to remove the tag from.

    try:
        api_instance.remove_user_tag(tag_id, user_id)
    except Exception as e:
        print("Exception when calling TagsApi->remove_user_tag: %s\n" % e)

Parameters

Name	Type	Description	Notes
tag_id	str	The ID of the tag to remove.
user_id	str	The ID of the user to remove the tag from.

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	Tag removed from user successfully.	-

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

Files

TagsApi.md

Latest commit

History

TagsApi.md

File metadata and controls

opal_security.TagsApi

add_group_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_resource_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

add_user_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

create_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

delete_tag_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_tag_by_id

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_tags

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_group_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_resource_tag

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

remove_user_tag

Example

Parameters