References SecurityScheme
Reference
C
Class

ApiPlatform\OpenApi\Model\SecurityScheme

class ApiPlatform\OpenApi\Model\SecurityScheme
{
    public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)
    public getType(): string
    public getDescription(): string
    public getName(): string
    public getIn(): string
    public getScheme(): string
    public getBearerFormat(): string
    public getFlows(): ApiPlatform\OpenApi\Model\OAuthFlows
    public getOpenIdConnectUrl(): string
    public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme
    public withDescription(string $description): ApiPlatform\OpenApi\Model\SecurityScheme
    public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme
    public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme
    public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme
    public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme
    public withFlows($flows): `<a href="/docs/main/references/OpenApi/Model/SecurityScheme">ApiPlatform\OpenApi\Model\SecurityScheme
    public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme
    public withExtensionProperty(string $key, $value)
    public getExtensionProperties(): array
}

Methods

__construct

public __construct(null|string $type, string $description, null|string $name, null|string $in, null|string $scheme, null|string $bearerFormat, null|ApiPlatform\OpenApi\Model\OAuthFlows $flows, null|string $openIdConnectUrl)

Parameters

typestring
descriptionstring
namestring
instring
schemestring
bearerFormatstring
flows`ApiPlatform\OpenApi\Model\OAuthFlows`
openIdConnectUrlstring

getType

public getType(): string

Returns

string

getDescription

public getDescription(): string

Returns

string

getName

public getName(): string

Returns

string

getIn

public getIn(): string

Returns

string

getScheme

public getScheme(): string

Returns

string

getBearerFormat

public getBearerFormat(): string

Returns

string

getFlows

Returns

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

getOpenIdConnectUrl

public getOpenIdConnectUrl(): string

Returns

string

withType

public withType(string $type): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

typestring

Returns

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

withDescription

public withDescription(string $description): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

descriptionstring

Returns

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

withName

public withName(string $name): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

namestring

Returns

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

withIn

public withIn(string $in): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

instring

Returns

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

withScheme

public withScheme(string $scheme): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

schemestring

Returns

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

withBearerFormat

public withBearerFormat(string $bearerFormat): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

bearerFormatstring

Returns

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

withFlows

Parameters

flows`ApiPlatform\OpenApi\Model\OAuthFlows`

Returns

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

withOpenIdConnectUrl

public withOpenIdConnectUrl(string $openIdConnectUrl): ApiPlatform\OpenApi\Model\SecurityScheme

Parameters

openIdConnectUrlstring

Returns

<a href="/docs/main/references/OpenApi/Model/SecurityScheme">ApiPlatform\OpenApi\Model\SecurityScheme</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