airflow_client.client.RoleApi

All URIs are relative to /api/v1

Method	HTTP request	Description
delete_role	DELETE /roles/{role_name}	Delete a role
get_role	GET /roles/{role_name}	Get a role
get_roles	GET /roles	List roles
patch_role	PATCH /roles/{role_name}	Update a role
post_role	POST /roles	Create a role

delete_role

delete_role(role_name)

Delete a role

Delete a role. This API endpoint is deprecated, please use the endpoint /auth/fab/v1 for this operation instead.

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import role_api
from airflow_client.client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/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 HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = role_api.RoleApi(api_client)
    role_name = "role_name_example" # str | The role name

    # example passing only required values which don't have defaults set
    try:
        # Delete a role
        api_instance.delete_role(role_name)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->delete_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_name	str	The role name

Return type

void (empty response body)

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Success.	-
400	Client specified an invalid argument.	-
401	Request not authenticated due to missing, invalid, authentication info.	-
403	Client does not have sufficient permission.	-
404	A specified resource is not found.	-

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

get_role

Role get_role(role_name)

Get a role

Get a role. This API endpoint is deprecated, please use the endpoint /auth/fab/v1 for this operation instead.

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import role_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.role import Role
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/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 HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = role_api.RoleApi(api_client)
    role_name = "role_name_example" # str | The role name

    # example passing only required values which don't have defaults set
    try:
        # Get a role
        api_response = api_instance.get_role(role_name)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->get_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_name	str	The role name

Return type

Role

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success.	-
401	Request not authenticated due to missing, invalid, authentication info.	-
403	Client does not have sufficient permission.	-
404	A specified resource is not found.	-

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

get_roles

RoleCollection get_roles()

List roles

Get a list of roles. This API endpoint is deprecated, please use the endpoint /auth/fab/v1 for this operation instead.

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import role_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.role_collection import RoleCollection
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/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 HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = role_api.RoleApi(api_client)
    limit = 100 # int | The numbers of items to return. (optional) if omitted the server will use the default value of 100
    offset = 0 # int | The number of items to skip before starting to collect the result set. (optional)
    order_by = "order_by_example" # str | The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order.  *New in version 2.1.0*  (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List roles
        api_response = api_instance.get_roles(limit=limit, offset=offset, order_by=order_by)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->get_roles: %s\n" % e)

Parameters

Name	Type	Description	Notes
limit	int	The numbers of items to return.	[optional] if omitted the server will use the default value of 100
offset	int	The number of items to skip before starting to collect the result set.	[optional]
order_by	str	The name of the field to order the results by. Prefix a field name with `-` to reverse the sort order. New in version 2.1.0	[optional]

Return type

RoleCollection

Authorization

Basic, Kerberos

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success.	-
401	Request not authenticated due to missing, invalid, authentication info.	-
403	Client does not have sufficient permission.	-

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

patch_role

Role patch_role(role_name, role)

Update a role

Update a role. This API endpoint is deprecated, please use the endpoint /auth/fab/v1 for this operation instead.

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import role_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.role import Role
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/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 HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = role_api.RoleApi(api_client)
    role_name = "role_name_example" # str | The role name
    role = Role(
        actions=[
            ActionResource(
                action=Action(
                    name="name_example",
                ),
                resource=Resource(
                    name="name_example",
                ),
            ),
        ],
        name="name_example",
    ) # Role | 
    update_mask = [
        "update_mask_example",
    ] # [str] | The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.  (optional)

    # example passing only required values which don't have defaults set
    try:
        # Update a role
        api_response = api_instance.patch_role(role_name, role)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->patch_role: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Update a role
        api_response = api_instance.patch_role(role_name, role, update_mask=update_mask)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->patch_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_name	str	The role name
role	Role
update_mask	[str]	The fields to update on the resource. If absent or empty, all modifiable fields are updated. A comma-separated list of fully qualified names of fields.	[optional]

Return type

Role

Authorization

Basic, Kerberos

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success.	-
400	Client specified an invalid argument.	-
401	Request not authenticated due to missing, invalid, authentication info.	-
403	Client does not have sufficient permission.	-
404	A specified resource is not found.	-

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

post_role

Role post_role(role)

Create a role

Create a new role. This API endpoint is deprecated, please use the endpoint /auth/fab/v1 for this operation instead.

Example

Basic Authentication (Basic):

import time
import airflow_client.client
from airflow_client.client.api import role_api
from airflow_client.client.model.error import Error
from airflow_client.client.model.role import Role
from pprint import pprint
# Defining the host is optional and defaults to /api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = airflow_client.client.Configuration(
    host = "/api/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 HTTP basic authorization: Basic
configuration = airflow_client.client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Enter a context with an instance of the API client
with airflow_client.client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = role_api.RoleApi(api_client)
    role = Role(
        actions=[
            ActionResource(
                action=Action(
                    name="name_example",
                ),
                resource=Resource(
                    name="name_example",
                ),
            ),
        ],
        name="name_example",
    ) # Role | 

    # example passing only required values which don't have defaults set
    try:
        # Create a role
        api_response = api_instance.post_role(role)
        pprint(api_response)
    except airflow_client.client.ApiException as e:
        print("Exception when calling RoleApi->post_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role	Role

Return type

Role

Authorization

Basic, Kerberos

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Success.	-
400	Client specified an invalid argument.	-
401	Request not authenticated due to missing, invalid, authentication info.	-
403	Client does not have sufficient permission.	-

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

Files

RoleApi.md

Latest commit

History

RoleApi.md

File metadata and controls

airflow_client.client.RoleApi

delete_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

get_roles

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

patch_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

post_role

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details