AuthorizationServerContract Class

Definition

External OAuth authorization server settings.

[Microsoft.Rest.Serialization.JsonTransformation]
public class AuthorizationServerContract : Microsoft.Azure.Management.ApiManagement.Models.Resource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type AuthorizationServerContract = class
    inherit Resource
Public Class AuthorizationServerContract
Inherits Resource
Inheritance
AuthorizationServerContract
Attributes

Constructors

AuthorizationServerContract()

Initializes a new instance of the AuthorizationServerContract class.

AuthorizationServerContract(String, String, String, IList<String>, String, String, String, String, String, IList<Nullable<AuthorizationMethod>>, IList<String>, IList<TokenBodyParameterContract>, String, Nullable<Boolean>, String, IList<String>, String, String, String)

Initializes a new instance of the AuthorizationServerContract class.

Properties

AuthorizationEndpoint

Gets or sets oAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.

AuthorizationMethods

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

BearerTokenSendingMethods

Gets or sets specifies the mechanism by which access token is passed to the API.

ClientAuthenticationMethod

Gets or sets 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

Gets or sets client or app id registered with this authorization server.

ClientRegistrationEndpoint

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

ClientSecret

Gets or sets 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

Gets or sets 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

Gets or sets description of the authorization server. Can contain HTML formatting tags.

DisplayName

Gets or sets user-friendly authorization server name.

GrantTypes

Gets or sets form of an authorization grant, which the client uses to request the access token.

Id

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

(Inherited from Resource)
Name

Gets the name of the resource

(Inherited from Resource)
ResourceOwnerPassword

Gets or sets can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

ResourceOwnerUsername

Gets or sets can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

SupportState

Gets or sets 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

Gets or sets 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

Gets or sets oAuth token endpoint. Contains absolute URI to entity being referenced.

Type

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

(Inherited from Resource)

Methods

Validate()

Validate the object.

Applies to