Skip to content

PersonalAccessTokenV1alpha1UcApi.md

Latest commit

 

History

History
470 lines (321 loc) · 13.7 KB

PersonalAccessTokenV1alpha1UcApi.md

File metadata and controls

470 lines (321 loc) · 13.7 KB

halo_client.PersonalAccessTokenV1alpha1UcApi

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

Method HTTP request Description
delete_pat DELETE /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens/{name}
generate_pat POST /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens
obtain_pat GET /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens/{name}
obtain_pats GET /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens
restore_pat PUT /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens/{name}/actions/restoration
revoke_pat PUT /apis/uc.api.security.halo.run/v1alpha1/personalaccesstokens/{name}/actions/revocation

delete_pat

delete_pat(name)

Delete a PAT

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.PersonalAccessTokenV1alpha1UcApi(api_client)
    name = 'name_example' # str | 

    try:
        api_instance.delete_pat(name)
    except Exception as e:
        print("Exception when calling PersonalAccessTokenV1alpha1UcApi->delete_pat: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

generate_pat

PersonalAccessToken generate_pat(personal_access_token)

Generate a PAT.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.personal_access_token import PersonalAccessToken
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.PersonalAccessTokenV1alpha1UcApi(api_client)
    personal_access_token = halo_client.PersonalAccessToken() # PersonalAccessToken | 

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

Parameters

Name Type Description Notes
personal_access_token PersonalAccessToken

Return type

PersonalAccessToken

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
0 default response -

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

obtain_pat

obtain_pat(name)

Obtain a PAT.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.PersonalAccessTokenV1alpha1UcApi(api_client)
    name = 'name_example' # str | 

    try:
        api_instance.obtain_pat(name)
    except Exception as e:
        print("Exception when calling PersonalAccessTokenV1alpha1UcApi->obtain_pat: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

obtain_pats

List[PersonalAccessToken] obtain_pats()

Obtain PAT list.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.models.personal_access_token import PersonalAccessToken
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

List[PersonalAccessToken]

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

HTTP response details

Status code Description Response headers
0 default response -

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

restore_pat

restore_pat(name)

Restore a PAT.

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.PersonalAccessTokenV1alpha1UcApi(api_client)
    name = 'name_example' # str | 

    try:
        api_instance.restore_pat(name)
    except Exception as e:
        print("Exception when calling PersonalAccessTokenV1alpha1UcApi->restore_pat: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

revoke_pat

revoke_pat(name)

Revoke a PAT

Example

  • Basic Authentication (basicAuth):
  • Bearer (JWT) Authentication (bearerAuth):
import halo_client
from halo_client.rest import ApiException
from pprint import pprint

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

# 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: basicAuth
configuration = halo_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)

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

# Enter a context with an instance of the API client
with halo_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = halo_client.PersonalAccessTokenV1alpha1UcApi(api_client)
    name = 'name_example' # str | 

    try:
        api_instance.revoke_pat(name)
    except Exception as e:
        print("Exception when calling PersonalAccessTokenV1alpha1UcApi->revoke_pat: %s\n" % e)

Parameters

Name Type Description Notes
name str

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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