pulumi-azure-native-kotlin/com.pulumi.azurenative.apimanagement.kotlin.outputs/GetAuthorizationServerResult

GetAuthorizationServerResult

data class GetAuthorizationServerResult(val authorizationEndpoint: String, val authorizationMethods: List<String>? = null, val bearerTokenSendingMethods: List<String>? = null, val clientAuthenticationMethod: List<String>? = null, val clientId: String, val clientRegistrationEndpoint: String, val clientSecret: String? = null, val defaultScope: String? = null, val description: String? = null, val displayName: String, val grantTypes: List<String>, val id: String, val name: String, val resourceOwnerPassword: String? = null, val resourceOwnerUsername: String? = null, val supportState: Boolean? = null, val tokenBodyParameters: List<TokenBodyParameterContractResponse>? = null, val tokenEndpoint: String? = null, val type: String, val useInApiDocumentation: Boolean? = null, val useInTestConsole: Boolean? = null)

External OAuth authorization server settings.

Constructors

fun GetAuthorizationServerResult(authorizationEndpoint: String, authorizationMethods: List<String>? = null, bearerTokenSendingMethods: List<String>? = null, clientAuthenticationMethod: List<String>? = null, clientId: String, clientRegistrationEndpoint: String, clientSecret: String? = null, defaultScope: String? = null, description: String? = null, displayName: String, grantTypes: List<String>, id: String, name: String, resourceOwnerPassword: String? = null, resourceOwnerUsername: String? = null, supportState: Boolean? = null, tokenBodyParameters: List<TokenBodyParameterContractResponse>? = null, tokenEndpoint: String? = null, type: String, useInApiDocumentation: Boolean? = null, useInTestConsole: Boolean? = null)

Types

Companion

object Companion

Properties

authorizationEndpoint

val authorizationEndpoint: String

OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.

authorizationMethods

val authorizationMethods: List<String>? = null

HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

bearerTokenSendingMethods

val bearerTokenSendingMethods: List<String>? = null

Specifies the mechanism by which access token is passed to the API.

clientAuthenticationMethod

val clientAuthenticationMethod: List<String>? = null

Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

clientId

val clientId: String

Client or app id registered with this authorization server.

clientRegistrationEndpoint

val clientRegistrationEndpoint: String

Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

clientSecret

val clientSecret: String? = null

Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

defaultScope

val defaultScope: String? = null

Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

description

val description: String? = null

Description of the authorization server. Can contain HTML formatting tags.

displayName

val displayName: String

User-friendly authorization server name.

grantTypes

val grantTypes: List<String>

Form of an authorization grant, which the client uses to request the access token.

val id: String

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

val name: String

The name of the resource

resourceOwnerPassword

val resourceOwnerPassword: String? = null

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

resourceOwnerUsername

val resourceOwnerUsername: String? = null

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

supportState

val supportState: Boolean? = null

If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

tokenBodyParameters

val tokenBodyParameters: List<TokenBodyParameterContractResponse>? = null

Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

tokenEndpoint

val tokenEndpoint: String? = null

OAuth token endpoint. Contains absolute URI to entity being referenced.

type

val type: String

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

useInApiDocumentation

val useInApiDocumentation: Boolean? = null

If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.

useInTestConsole

val useInTestConsole: Boolean? = null

If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.