Skip to main content

Service principals

Manage service principals — non-human identities that own API tokens for programmatic access.

Methods​

MethodDescription
create_service_principalCreate a new service principal
alter_service_principalRename a service principal
delete_service_principalDelete a service principal
show_service_principalsList all service principals

create_service_principal​

create_service_principal(name: str, *, unsafe_raw=False, timeout=None, poll_interval=None)

Example​

client.create_service_principal("ci_bot")

alter_service_principal​

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

Example​

client.alter_service_principal("ci_bot", new_name="ci_bot_v2")

delete_service_principal​

delete_service_principal(name: str, *, unsafe_raw=False, timeout=None, poll_interval=None)

Example​

client.delete_service_principal("ci_bot")

show_service_principals​

show_service_principals(*, timeout=None, poll_interval=None)

Example​

result = client.show_service_principals()