rbtools.api.resource.oauth_application¶

Resource definitions for OAuth2 applications.

Classes

class rbtools.api.resource.oauth_application.OAuthApplicationGetListParams[source]¶

Bases: BaseGetListParams

Params for the OAuth2 application list GET operation.

Added in version 6.0.

__firstlineno__ = 119¶

__static_attributes__ = ()¶

username: str¶

A user to filter for.

If present, the results will be filtered to applications owned by the specified user.

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

Bases: ItemResource

Item resource for OAuth2 applications.

This corresponds to Review Board’s OAuth2 Applications Resource.

Added in version 6.0.

__firstlineno__ = 29¶

__static_attributes__ = ()¶

authorization_grant_type: Literal['authorization-code', 'client-credentials', 'implicit', 'password']¶

How the authorization is granted to the application.

client_id: str¶

The client ID.

This will be used by your application to identify itself to Review Board.

client_secret: str¶

The client secret.

This should only be known to Review Board and the application.

client_type: Literal['confidential', 'public']¶

The type of client.

Public clients may include the client_secret in published information (for example, JavaScript code served to a browser). Confidential clients must be able to keep the secret private.

enabled: bool¶

Whether or not this application is enabled.

If disabled, authentication and API access will not be available for clients using this application.

extra_data: ResourceExtraDataField¶

Extra information associated with the application.

get_user(**kwargs: Unpack[UserGetParams]) → UserItemResource[source]¶

Get the user who created the application.

Parameters:

**kwargs (dict) – Query arguments to include with the request.

Returns:

The user item resource.

Return type:

rbtools.api.resource.UserItemResource

Raises:

• rbtools.api.errors.APIError – The Review Board API returned an error.

• rbtools.api.errors.ServerInterfaceError – An error occurred while communicating with the server.

id: int¶

The application ID.

This uniquely identifies the application when communicating with the Web API.

name: str¶

The application name.

redirect_uris: list[str]¶

The list of allowed URIs to redirect to.

skip_authorization: bool¶

Whether or not users will be prompted for authentication.

This field is only editable by administrators.

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

Bases: ListResource[OAuthApplicationItemResource]

List resource for OAuth2 applications.

This corresponds to Review Board’s OAuth2 Applications List Resource.

Added in version 6.0.

__annotations_cache__ = {}¶

__firstlineno__ = 133¶

__static_attributes__ = ()¶