OAuthFlow
in package
implements
OpenApiAttributeInterface
Configuration details for a supported OAuth Flow.
Interfaces, Classes, Traits and Enums
Table of Contents
- $authorizationUrl : string
- $extensions : array<string|int, mixed>
- $refreshUrl : string
- $scopes : array<string|int, mixed>
- $tokenUrl : string
- __construct() : mixed
Properties
$authorizationUrl
public
string
$authorizationUrl
= ""
$extensions
public
array<string|int, mixed>
$extensions
= []
$refreshUrl
public
string
$refreshUrl
= ""
$scopes
public
array<string|int, mixed>
$scopes
= []
$tokenUrl
public
string
$tokenUrl
= ""
Methods
__construct()
public
__construct([string $authorizationUrl = "" ][, string $tokenUrl = "" ][, string $refreshUrl = "" ][, array<string|int, OAuthScope> $scopes = [] ][, array<string|int, Extension> $extensions = [] ]) : mixed
Parameters
- $authorizationUrl : string = ""
-
The authorization URL to be used for this flow. This must be in the form of a URL. Applies to oauth2 ("implicit", "authorizationCode") type.
- $tokenUrl : string = ""
-
The token URL to be used for this flow. This must be in the form of a URL. Applies to oauth2 ("password", "clientCredentials", "authorizationCode") type.
- $refreshUrl : string = ""
-
The URL to be used for obtaining refresh tokens. This must be in the form of a URL. Applies to oauth2 type.
- $scopes : array<string|int, OAuthScope> = []
-
The available scopes for the OAuth2 security scheme. Applies to oauth2 type.
- $extensions : array<string|int, Extension> = []
-
The list of optional extensions.