unreal.WebAPIOAuthSettings

class unreal.WebAPIOAuthSettings(outer: Object | None = None, name: Name | str = 'None')

Bases: WebAPIAuthenticationSettings

Web APIOAuth Settings

C++ Source:

  • Plugin: WebAPI

  • Module: WebAPI

  • File: WebAPIAuthentication.h

Editor Properties: (see get_editor_property/set_editor_property)

  • access_token (str): [Read-Only] Private token returned by the server.

  • additional_request_body_parameters (Map[str, str]): [Read-Write] Additional content key/value pairs to add to auth request.

  • additional_request_query_parameters (Map[str, str]): [Read-Write] Additional query parameters to add to auth request. Each key should be present in the Url.

  • authentication_server (str): [Read-Write] Authentication endpoint.

  • client_id (str): [Read-Write] Public client identifier.

  • client_secret (str): [Read-Write] Private client secret.

  • expires_on (DateTime): [Read-Only] Private token expiration returned by the server.

  • scheme_name (Name): [Read-Write] Public client identifier.

  • token_type (str): [Read-Write] Token type, ie. Bearer

property access_token: str

[Read-Only] Private token returned by the server.

Type:

(str)

property additional_request_body_parameters: None

[Read-Write] Additional content key/value pairs to add to auth request.

Type:

(Map[str, str])

property additional_request_query_parameters: None

[Read-Write] Additional query parameters to add to auth request. Each key should be present in the Url.

Type:

(Map[str, str])

property authentication_server: str

[Read-Write] Authentication endpoint.

Type:

(str)

property client_id: str

[Read-Write] Public client identifier.

Type:

(str)

property client_secret: str

[Read-Write] Private client secret.

Type:

(str)

property expires_on: DateTime

[Read-Only] Private token expiration returned by the server.

Type:

(DateTime)

property token_type: str

[Read-Write] Token type, ie. Bearer

Type:

(str)