References OAuthFlow
Reference
C
Class

ApiPlatform\OpenApi\Model\OAuthFlow

class ApiPlatform\OpenApi\Model\OAuthFlow
{
    public __construct(null|string $authorizationUrl, null|string $tokenUrl, null|string $refreshUrl, null|ArrayObject $scopes)
    public getAuthorizationUrl(): string
    public getTokenUrl(): string
    public getRefreshUrl(): string
    public getScopes(): ArrayObject
    public withAuthorizationUrl(string $authorizationUrl): ApiPlatform\OpenApi\Model\OAuthFlow
    public withTokenUrl(string $tokenUrl): ApiPlatform\OpenApi\Model\OAuthFlow
    public withRefreshUrl(string $refreshUrl): ApiPlatform\OpenApi\Model\OAuthFlow
    public withScopes(ArrayObject $scopes): ApiPlatform\OpenApi\Model\OAuthFlow
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|string $authorizationUrl, null|string $tokenUrl, null|string $refreshUrl, null|ArrayObject $scopes)

Parameters

authorizationUrlstring
tokenUrlstring
refreshUrlstring
scopesArrayObject

getAuthorizationUrl

public getAuthorizationUrl(): string

Returns

string

getTokenUrl

public getTokenUrl(): string

Returns

string

getRefreshUrl

public getRefreshUrl(): string

Returns

string

getScopes

public getScopes(): ArrayObject

Returns

ArrayObject

withAuthorizationUrl

public withAuthorizationUrl(string $authorizationUrl): ApiPlatform\OpenApi\Model\OAuthFlow

Parameters

authorizationUrlstring

Returns

<a href="/docs/main/references/OpenApi/Model/OAuthFlow">ApiPlatform\OpenApi\Model\OAuthFlow</a>

withTokenUrl

public withTokenUrl(string $tokenUrl): ApiPlatform\OpenApi\Model\OAuthFlow

Parameters

tokenUrlstring

Returns

<a href="/docs/main/references/OpenApi/Model/OAuthFlow">ApiPlatform\OpenApi\Model\OAuthFlow</a>

withRefreshUrl

public withRefreshUrl(string $refreshUrl): ApiPlatform\OpenApi\Model\OAuthFlow

Parameters

refreshUrlstring

Returns

<a href="/docs/main/references/OpenApi/Model/OAuthFlow">ApiPlatform\OpenApi\Model\OAuthFlow</a>

withScopes

public withScopes(ArrayObject $scopes): ApiPlatform\OpenApi\Model\OAuthFlow

Parameters

scopesArrayObject

Returns

<a href="/docs/main/references/OpenApi/Model/OAuthFlow">ApiPlatform\OpenApi\Model\OAuthFlow</a>

withExtensionProperty

public withExtensionProperty(string $key, $value)

Parameters

keystring
value

Returns

getExtensionProperties

public getExtensionProperties(): array

Returns

array

Made with love by

Les-Tilleuls.coop can help you design and develop your APIs and web projects, and train your teams in API Platform, Symfony, Next.js, Kubernetes and a wide range of other technologies.

Learn more

Copyright © 2023 Kévin Dunglas

Sponsored by Les-Tilleuls.coop