Skip to main content

API tokens

Create and delete API tokens scoped to a service principal.

Methods​

MethodDescription
create_api_tokenIssue a new API token for a service principal
delete_api_tokenRevoke an API token

create_api_token​

create_api_token(
    name: str,
    *,
    service_principal: str,
    unsafe_raw: bool = False,
    timeout: float | None = None,
    poll_interval: float | None = None,
)

Example​

result = client.create_api_token("ci_bot_token", service_principal="ci_bot")
# The token value is in result.api_response — store it securely; it is shown only once.

delete_api_token​

delete_api_token(
    name: str,
    *,
    service_principal: str,
    unsafe_raw: bool = False,
    timeout: float | None = None,
    poll_interval: float | None = None,
)

Example​

client.delete_api_token("ci_bot_token", service_principal="ci_bot")