azure-docs-sdk-java/legacy/docs-ref-autogen/com.microsoft.azure.managem...

300 строки
30 KiB
YAML

### YamlMime:JavaType
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties"
name: "AuthorizationServerContractBaseProperties"
nameWithType: "AuthorizationServerContractBaseProperties"
summary: "External OAuth authorization server Update settings contract."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
methodsRef:
- "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
- "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **AuthorizationServerContractBaseProperties**"
constructors:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.AuthorizationServerContractBaseProperties()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.AuthorizationServerContractBaseProperties()"
name: "AuthorizationServerContractBaseProperties()"
nameWithType: "AuthorizationServerContractBaseProperties.AuthorizationServerContractBaseProperties()"
syntax: "public AuthorizationServerContractBaseProperties()"
methods:
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.authorizationMethods()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.authorizationMethods()"
name: "authorizationMethods()"
nameWithType: "AuthorizationServerContractBaseProperties.authorizationMethods()"
summary: "Get hTTP verbs supported by the authorization endpoint."
syntax: "public List<AuthorizationMethod> authorizationMethods()"
desc: "Get hTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional."
returns:
description: "the authorizationMethods value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod&text=AuthorizationMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.bearerTokenSendingMethods()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.bearerTokenSendingMethods()"
name: "bearerTokenSendingMethods()"
nameWithType: "AuthorizationServerContractBaseProperties.bearerTokenSendingMethods()"
summary: "Get specifies the mechanism by which access token is passed to the API."
syntax: "public List<BearerTokenSendingMethod> bearerTokenSendingMethods()"
desc: "Get specifies the mechanism by which access token is passed to the API."
returns:
description: "the bearerTokenSendingMethods value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod&text=BearerTokenSendingMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.clientAuthenticationMethod()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.clientAuthenticationMethod()"
name: "clientAuthenticationMethod()"
nameWithType: "AuthorizationServerContractBaseProperties.clientAuthenticationMethod()"
summary: "Get method of authentication supported by the token endpoint of this authorization server."
syntax: "public List<ClientAuthenticationMethod> clientAuthenticationMethod()"
desc: "Get 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."
returns:
description: "the clientAuthenticationMethod value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod&text=ClientAuthenticationMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.clientSecret()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.clientSecret()"
name: "clientSecret()"
nameWithType: "AuthorizationServerContractBaseProperties.clientSecret()"
summary: "Get client or app secret registered with this authorization server."
syntax: "public String clientSecret()"
desc: "Get client or app secret registered with this authorization server."
returns:
description: "the clientSecret value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.defaultScope()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.defaultScope()"
name: "defaultScope()"
nameWithType: "AuthorizationServerContractBaseProperties.defaultScope()"
summary: "Get access token scope that is going to be requested by default."
syntax: "public String defaultScope()"
desc: "Get 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."
returns:
description: "the defaultScope value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.description()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.description()"
name: "description()"
nameWithType: "AuthorizationServerContractBaseProperties.description()"
summary: "Get description of the authorization server."
syntax: "public String description()"
desc: "Get description of the authorization server. Can contain HTML formatting tags."
returns:
description: "the description value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.resourceOwnerPassword()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.resourceOwnerPassword()"
name: "resourceOwnerPassword()"
nameWithType: "AuthorizationServerContractBaseProperties.resourceOwnerPassword()"
summary: "Get can be optionally specified when resource owner password grant type is supported by this authorization server."
syntax: "public String resourceOwnerPassword()"
desc: "Get can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password."
returns:
description: "the resourceOwnerPassword value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.resourceOwnerUsername()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.resourceOwnerUsername()"
name: "resourceOwnerUsername()"
nameWithType: "AuthorizationServerContractBaseProperties.resourceOwnerUsername()"
summary: "Get can be optionally specified when resource owner password grant type is supported by this authorization server."
syntax: "public String resourceOwnerUsername()"
desc: "Get can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username."
returns:
description: "the resourceOwnerUsername value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.supportState()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.supportState()"
name: "supportState()"
nameWithType: "AuthorizationServerContractBaseProperties.supportState()"
summary: "Get if true, authorization server will include state parameter from the authorization request to its response."
syntax: "public Boolean supportState()"
desc: "Get if true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security."
returns:
description: "the supportState value"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.tokenBodyParameters()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.tokenBodyParameters()"
name: "tokenBodyParameters()"
nameWithType: "AuthorizationServerContractBaseProperties.tokenBodyParameters()"
summary: "Get 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.<wbr>e."
syntax: "public List<TokenBodyParameterContract> tokenBodyParameters()"
desc: "Get 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\"\\}."
returns:
description: "the tokenBodyParameters value"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract&text=TokenBodyParameterContract\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.tokenEndpoint()"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.tokenEndpoint()"
name: "tokenEndpoint()"
nameWithType: "AuthorizationServerContractBaseProperties.tokenEndpoint()"
summary: "Get o<wbr>Auth token endpoint."
syntax: "public String tokenEndpoint()"
desc: "Get oAuth token endpoint. Contains absolute URI to entity being referenced."
returns:
description: "the tokenEndpoint value"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withAuthorizationMethods(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
name: "withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
nameWithType: "AuthorizationServerContractBaseProperties.withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
summary: "Set hTTP verbs supported by the authorization endpoint."
parameters:
- description: "the authorizationMethods value to set"
name: "authorizationMethods"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod&text=AuthorizationMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public AuthorizationServerContractBaseProperties withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
desc: "Set hTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withBearerTokenSendingMethods(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
name: "withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
nameWithType: "AuthorizationServerContractBaseProperties.withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
summary: "Set specifies the mechanism by which access token is passed to the API."
parameters:
- description: "the bearerTokenSendingMethods value to set"
name: "bearerTokenSendingMethods"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod&text=BearerTokenSendingMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public AuthorizationServerContractBaseProperties withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
desc: "Set specifies the mechanism by which access token is passed to the API."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withClientAuthenticationMethod(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
name: "withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
nameWithType: "AuthorizationServerContractBaseProperties.withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
summary: "Set method of authentication supported by the token endpoint of this authorization server."
parameters:
- description: "the clientAuthenticationMethod value to set"
name: "clientAuthenticationMethod"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod&text=ClientAuthenticationMethod\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public AuthorizationServerContractBaseProperties withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
desc: "Set 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."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withClientSecret(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withClientSecret(String clientSecret)"
name: "withClientSecret(String clientSecret)"
nameWithType: "AuthorizationServerContractBaseProperties.withClientSecret(String clientSecret)"
summary: "Set client or app secret registered with this authorization server."
parameters:
- description: "the clientSecret value to set"
name: "clientSecret"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withClientSecret(String clientSecret)"
desc: "Set client or app secret registered with this authorization server."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withDefaultScope(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withDefaultScope(String defaultScope)"
name: "withDefaultScope(String defaultScope)"
nameWithType: "AuthorizationServerContractBaseProperties.withDefaultScope(String defaultScope)"
summary: "Set access token scope that is going to be requested by default."
parameters:
- description: "the defaultScope value to set"
name: "defaultScope"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withDefaultScope(String defaultScope)"
desc: "Set 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."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withDescription(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withDescription(String description)"
name: "withDescription(String description)"
nameWithType: "AuthorizationServerContractBaseProperties.withDescription(String description)"
summary: "Set description of the authorization server."
parameters:
- description: "the description value to set"
name: "description"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withDescription(String description)"
desc: "Set description of the authorization server. Can contain HTML formatting tags."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withResourceOwnerPassword(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withResourceOwnerPassword(String resourceOwnerPassword)"
name: "withResourceOwnerPassword(String resourceOwnerPassword)"
nameWithType: "AuthorizationServerContractBaseProperties.withResourceOwnerPassword(String resourceOwnerPassword)"
summary: "Set can be optionally specified when resource owner password grant type is supported by this authorization server."
parameters:
- description: "the resourceOwnerPassword value to set"
name: "resourceOwnerPassword"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withResourceOwnerPassword(String resourceOwnerPassword)"
desc: "Set can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withResourceOwnerUsername(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withResourceOwnerUsername(String resourceOwnerUsername)"
name: "withResourceOwnerUsername(String resourceOwnerUsername)"
nameWithType: "AuthorizationServerContractBaseProperties.withResourceOwnerUsername(String resourceOwnerUsername)"
summary: "Set can be optionally specified when resource owner password grant type is supported by this authorization server."
parameters:
- description: "the resourceOwnerUsername value to set"
name: "resourceOwnerUsername"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withResourceOwnerUsername(String resourceOwnerUsername)"
desc: "Set can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withSupportState(java.lang.Boolean)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withSupportState(Boolean supportState)"
name: "withSupportState(Boolean supportState)"
nameWithType: "AuthorizationServerContractBaseProperties.withSupportState(Boolean supportState)"
summary: "Set if true, authorization server will include state parameter from the authorization request to its response."
parameters:
- description: "the supportState value to set"
name: "supportState"
type: "<xref href=\"java.lang.Boolean?alt=java.lang.Boolean&text=Boolean\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withSupportState(Boolean supportState)"
desc: "Set if true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withTokenBodyParameters(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract>)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
name: "withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
nameWithType: "AuthorizationServerContractBaseProperties.withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
summary: "Set 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.<wbr>e."
parameters:
- description: "the tokenBodyParameters value to set"
name: "tokenBodyParameters"
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract&text=TokenBodyParameterContract\" data-throw-if-not-resolved=\"False\" />&gt;"
syntax: "public AuthorizationServerContractBaseProperties withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
desc: "Set 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\"\\}."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withTokenEndpoint(java.lang.String)"
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties.withTokenEndpoint(String tokenEndpoint)"
name: "withTokenEndpoint(String tokenEndpoint)"
nameWithType: "AuthorizationServerContractBaseProperties.withTokenEndpoint(String tokenEndpoint)"
summary: "Set o<wbr>Auth token endpoint."
parameters:
- description: "the tokenEndpoint value to set"
name: "tokenEndpoint"
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
syntax: "public AuthorizationServerContractBaseProperties withTokenEndpoint(String tokenEndpoint)"
desc: "Set oAuth token endpoint. Contains absolute URI to entity being referenced."
returns:
description: "the AuthorizationServerContractBaseProperties object itself."
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerContractBaseProperties&text=AuthorizationServerContractBaseProperties\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "External OAuth authorization server Update settings contract."
metadata: {}
package: "com.microsoft.azure.management.apimanagement.v2019_01_01"
artifact: com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1