Skip to content

Signin  >  Structures  >  CreateOAuth2TokenRequestBody

CreateOAuth2TokenRequestBody

Structure Class

CreateOAuth2TokenRequestBody dataclass

Request body payload for CreateOAuth2Token operation The operation type is determined by the grant_type parameter: - grant_type=authorization_code: Requires code, redirect_uri, code_verifier - grant_type=refresh_token: Requires refresh_token

Attributes

client_id instance-attribute 
client_id: str

The client identifier (ARN) used during Sign-In onboarding Required for both authorization code and refresh token flows

code class-attribute instance-attribute 
code: str | None = None

The authorization code received from /v1/authorize Required only when grant_type=authorization_code

code_verifier class-attribute instance-attribute 
code_verifier: str | None = None

PKCE code verifier to prove possession of the original code challenge Required only when grant_type=authorization_code

grant_type instance-attribute 
grant_type: str

OAuth 2.0 grant type - determines which flow is used Must be "authorization_code" or "refresh_token"

redirect_uri class-attribute instance-attribute 
redirect_uri: str | None = None

The redirect URI that must match the original authorization request Required only when grant_type=authorization_code

refresh_token class-attribute instance-attribute 
refresh_token: str | None = field(repr=False, default=None)

The refresh token returned from auth_code redemption Required only when grant_type=refresh_token