rbtools.api.resource.api_token¶

Resource definitions for API tokens.

Classes

class rbtools.api.resource.api_token.APITokenItemResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, **kwargs)[source]¶

Bases: ItemResource

Item resource for API tokens.

This corresponds to Review Board’s API Token Resource.

Added in version 6.0.

__firstlineno__ = 23¶

__static_attributes__ = ()¶

deprecated: bool¶

Whether the token is deprecated.

This will be True if the token was generated by a deprecated token generator.

expired: bool¶

Whether the token is expired.

expires: str | None¶

An optional field for the date and time that the token will expire.

This is in ISO-8601 format. The token will be invalid and unusable for authentication after this point.

extra_data: ResourceExtraDataField¶

Extra data as part of the token.

id: int¶

The numeric ID of the API token.

invalid_date: str | None¶

The date and time at which the token became invalid, in ISO-8601 format.

invalid_reason: str¶

A message explaining why the token is no longer valid.

last_updated: str¶

The date and time the token was last updated, in ISO-8601 format.

last_used: str | None¶

The date and time the token was last used, in ISO-8601 format.

If the token has never been used, this will be None.

note: str¶

A user-provided note about the token.

policy: JSONDict¶

The access policies for the token.

time_added: str¶

The date and time the token was created, in ISO-8601 format.

token: str¶

The token value.

token_generator_id: str¶

The ID of the token generator that generated the token.

valid: bool¶

Whether the token is currently valid.

class rbtools.api.resource.api_token.APITokenListResource(transport: Transport, payload: JSONDict, url: str, token: str | None = None, item_mime_type: str | None = None, **kwargs)[source]¶

Bases: ListResource[APITokenItemResource]

List resource for API tokens.

This corresponds to Review Board’s API Token List Resource.

Added in version 6.0.

__firstlineno__ = 91¶

__static_attributes__ = ()¶