Documentation

AuthResult
in package
implements OneOfInterface

AuthResult Class Doc Comment

Tags
description

The authentication result. Depending on the response_format in the request this is either the full Auth object ("auth", the default) or only its Base64 encoded JSON serialization ("base64")

author

OpenAPI Generator team

link
https://openapi-generator.tech

Table of Contents

Interfaces

OneOfInterface
Interface implemented by models generated from a `oneOf` schema.

Constants

DISCRIMINATOR  : string|null = null
The discriminator property name, or null when the schema has no discriminator.
MODEL_NAME  : string = 'AuthResult'
The original name of the model.

Methods

getOneOfDiscriminator()  : string|null
Name of the discriminator property used to resolve the concrete member type, or null when the schema has no discriminator.
getOneOfDiscriminatorMappings()  : array<string, string>
Mapping of discriminator values to the concrete member type. Empty when the schema has no discriminator.
getOneOfTypes()  : array<string|int, string>
List of the types a value of this `oneOf` schema may be. Each entry uses the same notation as the values of {@see ModelInterface::openAPITypes()}.

Constants

DISCRIMINATOR

The discriminator property name, or null when the schema has no discriminator.

public string|null DISCRIMINATOR = null

MODEL_NAME

The original name of the model.

public string MODEL_NAME = 'AuthResult'

Methods

getOneOfDiscriminator()

Name of the discriminator property used to resolve the concrete member type, or null when the schema has no discriminator.

public static getOneOfDiscriminator() : string|null
Return values
string|null

getOneOfDiscriminatorMappings()

Mapping of discriminator values to the concrete member type. Empty when the schema has no discriminator.

public static getOneOfDiscriminatorMappings() : array<string, string>
Return values
array<string, string>

getOneOfTypes()

List of the types a value of this `oneOf` schema may be. Each entry uses the same notation as the values of {@see ModelInterface::openAPITypes()}.

public static getOneOfTypes() : array<string|int, string>
Return values
array<string|int, string>
On this page

Search results