AuthorizationServerContractProperties interface

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

authorizationEndpoint: string

Property Value

Client or app id registered with this authorization server.

clientId: string

Property Value

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

clientRegistrationEndpoint: string

Property Value

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.

clientSecret?: string

Property Value

User-friendly authorization server name.

displayName: string

Property Value

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

grantTypes: string[]

Property Value

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

useInApiDocumentation?: boolean

Property Value

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

useInTestConsole?: boolean

Property Value

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

authorizationMethods?: AuthorizationMethod[]

Property Value

Inherited From AuthorizationServerContractBaseProperties.authorizationMethods

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

bearerTokenSendingMethods?: string[]

Property Value

Inherited From AuthorizationServerContractBaseProperties.bearerTokenSendingMethods

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.

clientAuthenticationMethod?: string[]

Property Value

Inherited From AuthorizationServerContractBaseProperties.clientAuthenticationMethod

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.

defaultScope?: string

Property Value

Inherited From AuthorizationServerContractBaseProperties.defaultScope

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

description?: string

Property Value

Inherited From AuthorizationServerContractBaseProperties.description

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

resourceOwnerPassword?: string

Property Value

Inherited From AuthorizationServerContractBaseProperties.resourceOwnerPassword

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

resourceOwnerUsername?: string

Property Value

Inherited From AuthorizationServerContractBaseProperties.resourceOwnerUsername

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

supportState?: boolean

Property Value

Inherited From AuthorizationServerContractBaseProperties.supportState

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"}.

tokenBodyParameters?: TokenBodyParameterContract[]

Property Value

Inherited From AuthorizationServerContractBaseProperties.tokenBodyParameters

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

tokenEndpoint?: string

Property Value

Inherited From AuthorizationServerContractBaseProperties.tokenEndpoint