426 строки
41 KiB
YAML
426 строки
41 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract"
|
|
name: "AuthorizationServerUpdateContract"
|
|
nameWithType: "AuthorizationServerUpdateContract"
|
|
summary: "External OAuth authorization server settings."
|
|
inheritances:
|
|
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
|
|
inheritedClassMethods:
|
|
- classRef: "<xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
methodsRef:
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.id()?alt=com.microsoft.azure.ProxyResource.id&text=id\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.name()?alt=com.microsoft.azure.ProxyResource.name&text=name\" data-throw-if-not-resolved=\"False\" />"
|
|
- "<xref href=\"com.microsoft.azure.ProxyResource.type()?alt=com.microsoft.azure.ProxyResource.type&text=type\" data-throw-if-not-resolved=\"False\" />"
|
|
- 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 **AuthorizationServerUpdateContract**</br> extends <xref href=\"com.microsoft.azure.ProxyResource?alt=com.microsoft.azure.ProxyResource&text=ProxyResource\" data-throw-if-not-resolved=\"False\" />"
|
|
constructors:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.AuthorizationServerUpdateContract()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.AuthorizationServerUpdateContract()"
|
|
name: "AuthorizationServerUpdateContract()"
|
|
nameWithType: "AuthorizationServerUpdateContract.AuthorizationServerUpdateContract()"
|
|
syntax: "public AuthorizationServerUpdateContract()"
|
|
methods:
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.authorizationEndpoint()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.authorizationEndpoint()"
|
|
name: "authorizationEndpoint()"
|
|
nameWithType: "AuthorizationServerUpdateContract.authorizationEndpoint()"
|
|
summary: "Get o<wbr>Auth authorization endpoint."
|
|
syntax: "public String authorizationEndpoint()"
|
|
desc: "Get oAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749\\#section-3.2."
|
|
returns:
|
|
description: "the authorizationEndpoint 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.AuthorizationServerUpdateContract.authorizationMethods()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.authorizationMethods()"
|
|
name: "authorizationMethods()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.bearerTokenSendingMethods()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.bearerTokenSendingMethods()"
|
|
name: "bearerTokenSendingMethods()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientAuthenticationMethod()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientAuthenticationMethod()"
|
|
name: "clientAuthenticationMethod()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientId()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientId()"
|
|
name: "clientId()"
|
|
nameWithType: "AuthorizationServerUpdateContract.clientId()"
|
|
summary: "Get client or app id registered with this authorization server."
|
|
syntax: "public String clientId()"
|
|
desc: "Get client or app id registered with this authorization server."
|
|
returns:
|
|
description: "the clientId 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.AuthorizationServerUpdateContract.clientRegistrationEndpoint()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientRegistrationEndpoint()"
|
|
name: "clientRegistrationEndpoint()"
|
|
nameWithType: "AuthorizationServerUpdateContract.clientRegistrationEndpoint()"
|
|
summary: "Get optional reference to a page where client or app registration for this authorization server is performed."
|
|
syntax: "public String clientRegistrationEndpoint()"
|
|
desc: "Get optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."
|
|
returns:
|
|
description: "the clientRegistrationEndpoint 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.AuthorizationServerUpdateContract.clientSecret()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.clientSecret()"
|
|
name: "clientSecret()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.defaultScope()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.defaultScope()"
|
|
name: "defaultScope()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.description()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.description()"
|
|
name: "description()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.displayName()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.displayName()"
|
|
name: "displayName()"
|
|
nameWithType: "AuthorizationServerUpdateContract.displayName()"
|
|
summary: "Get user-friendly authorization server name."
|
|
syntax: "public String displayName()"
|
|
desc: "Get user-friendly authorization server name."
|
|
returns:
|
|
description: "the displayName 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.AuthorizationServerUpdateContract.grantTypes()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.grantTypes()"
|
|
name: "grantTypes()"
|
|
nameWithType: "AuthorizationServerUpdateContract.grantTypes()"
|
|
summary: "Get form of an authorization grant, which the client uses to request the access token."
|
|
syntax: "public List<GrantType> grantTypes()"
|
|
desc: "Get form of an authorization grant, which the client uses to request the access token."
|
|
returns:
|
|
description: "the grantTypes value"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.GrantType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.GrantType&text=GrantType\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.resourceOwnerPassword()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.resourceOwnerPassword()"
|
|
name: "resourceOwnerPassword()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.resourceOwnerUsername()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.resourceOwnerUsername()"
|
|
name: "resourceOwnerUsername()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.supportState()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.supportState()"
|
|
name: "supportState()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.tokenBodyParameters()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.tokenBodyParameters()"
|
|
name: "tokenBodyParameters()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.tokenEndpoint()"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.tokenEndpoint()"
|
|
name: "tokenEndpoint()"
|
|
nameWithType: "AuthorizationServerUpdateContract.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.AuthorizationServerUpdateContract.withAuthorizationEndpoint(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withAuthorizationEndpoint(String authorizationEndpoint)"
|
|
name: "withAuthorizationEndpoint(String authorizationEndpoint)"
|
|
nameWithType: "AuthorizationServerUpdateContract.withAuthorizationEndpoint(String authorizationEndpoint)"
|
|
summary: "Set o<wbr>Auth authorization endpoint."
|
|
parameters:
|
|
- description: "the authorizationEndpoint value to set"
|
|
name: "authorizationEndpoint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AuthorizationServerUpdateContract withAuthorizationEndpoint(String authorizationEndpoint)"
|
|
desc: "Set oAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749\\#section-3.2."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withAuthorizationMethods(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationMethod>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
|
|
name: "withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
syntax: "public AuthorizationServerUpdateContract withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)"
|
|
desc: "Set hTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withBearerTokenSendingMethods(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.BearerTokenSendingMethod>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
|
|
name: "withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
syntax: "public AuthorizationServerUpdateContract withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)"
|
|
desc: "Set specifies the mechanism by which access token is passed to the API."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientAuthenticationMethod(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.ClientAuthenticationMethod>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
|
|
name: "withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
syntax: "public AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientId(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientId(String clientId)"
|
|
name: "withClientId(String clientId)"
|
|
nameWithType: "AuthorizationServerUpdateContract.withClientId(String clientId)"
|
|
summary: "Set client or app id registered with this authorization server."
|
|
parameters:
|
|
- description: "the clientId value to set"
|
|
name: "clientId"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AuthorizationServerUpdateContract withClientId(String clientId)"
|
|
desc: "Set client or app id registered with this authorization server."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientRegistrationEndpoint(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientRegistrationEndpoint(String clientRegistrationEndpoint)"
|
|
name: "withClientRegistrationEndpoint(String clientRegistrationEndpoint)"
|
|
nameWithType: "AuthorizationServerUpdateContract.withClientRegistrationEndpoint(String clientRegistrationEndpoint)"
|
|
summary: "Set optional reference to a page where client or app registration for this authorization server is performed."
|
|
parameters:
|
|
- description: "the clientRegistrationEndpoint value to set"
|
|
name: "clientRegistrationEndpoint"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AuthorizationServerUpdateContract withClientRegistrationEndpoint(String clientRegistrationEndpoint)"
|
|
desc: "Set optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientSecret(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withClientSecret(String clientSecret)"
|
|
name: "withClientSecret(String clientSecret)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract withClientSecret(String clientSecret)"
|
|
desc: "Set client or app secret registered with this authorization server."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDefaultScope(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDefaultScope(String defaultScope)"
|
|
name: "withDefaultScope(String defaultScope)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDescription(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDescription(String description)"
|
|
name: "withDescription(String description)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract withDescription(String description)"
|
|
desc: "Set description of the authorization server. Can contain HTML formatting tags."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDisplayName(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withDisplayName(String displayName)"
|
|
name: "withDisplayName(String displayName)"
|
|
nameWithType: "AuthorizationServerUpdateContract.withDisplayName(String displayName)"
|
|
summary: "Set user-friendly authorization server name."
|
|
parameters:
|
|
- description: "the displayName value to set"
|
|
name: "displayName"
|
|
type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public AuthorizationServerUpdateContract withDisplayName(String displayName)"
|
|
desc: "Set user-friendly authorization server name."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withGrantTypes(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.GrantType>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withGrantTypes(List<GrantType> grantTypes)"
|
|
name: "withGrantTypes(List<GrantType> grantTypes)"
|
|
nameWithType: "AuthorizationServerUpdateContract.withGrantTypes(List<GrantType> grantTypes)"
|
|
summary: "Set form of an authorization grant, which the client uses to request the access token."
|
|
parameters:
|
|
- description: "the grantTypes value to set"
|
|
name: "grantTypes"
|
|
type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" /><<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.GrantType?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.GrantType&text=GrantType\" data-throw-if-not-resolved=\"False\" />>"
|
|
syntax: "public AuthorizationServerUpdateContract withGrantTypes(List<GrantType> grantTypes)"
|
|
desc: "Set form of an authorization grant, which the client uses to request the access token."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withResourceOwnerPassword(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withResourceOwnerPassword(String resourceOwnerPassword)"
|
|
name: "withResourceOwnerPassword(String resourceOwnerPassword)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withResourceOwnerUsername(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withResourceOwnerUsername(String resourceOwnerUsername)"
|
|
name: "withResourceOwnerUsername(String resourceOwnerUsername)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withSupportState(java.lang.Boolean)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withSupportState(Boolean supportState)"
|
|
name: "withSupportState(Boolean supportState)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withTokenBodyParameters(java.util.List<com.microsoft.azure.management.apimanagement.v2019_01_01.TokenBodyParameterContract>)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
|
|
name: "withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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\" /><<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\" />>"
|
|
syntax: "public AuthorizationServerUpdateContract 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 AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withTokenEndpoint(java.lang.String)"
|
|
fullName: "com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract.withTokenEndpoint(String tokenEndpoint)"
|
|
name: "withTokenEndpoint(String tokenEndpoint)"
|
|
nameWithType: "AuthorizationServerUpdateContract.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 AuthorizationServerUpdateContract withTokenEndpoint(String tokenEndpoint)"
|
|
desc: "Set oAuth token endpoint. Contains absolute URI to entity being referenced."
|
|
returns:
|
|
description: "the AuthorizationServerUpdateContract object itself."
|
|
type: "<xref href=\"com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract?alt=com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract&text=AuthorizationServerUpdateContract\" data-throw-if-not-resolved=\"False\" />"
|
|
type: "class"
|
|
desc: "External OAuth authorization server settings."
|
|
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
|