Share via

AuthorizationServerUpdateContract Class

Package:
com.microsoft.azure.management.apimanagement.v2019_01_01
Maven Artifact:
com.microsoft.azure.apimanagement.v2019_01_01:azure-mgmt-apimanagement:1.0.0-beta-1
  • java.lang.Object
    • com.microsoft.azure.ProxyResource
      • com.microsoft.azure.management.apimanagement.v2019_01_01.AuthorizationServerUpdateContract

public class AuthorizationServerUpdateContract
extends com.microsoft.azure.ProxyResource

External OAuth authorization server settings.

Constructor Summary

Constructor Description
AuthorizationServerUpdateContract()

Method Summary

Modifier and Type Method and Description
java.lang.String authorizationEndpoint()

Get oAuth authorization endpoint.
java.util.List<AuthorizationMethod> authorizationMethods()

Get hTTP verbs supported by the authorization endpoint.
java.util.List<BearerTokenSendingMethod> bearerTokenSendingMethods()

Get specifies the mechanism by which access token is passed to the API.
java.util.List<ClientAuthenticationMethod> clientAuthenticationMethod()

Get method of authentication supported by the token endpoint of this authorization server.
java.lang.String clientId()

Get client or app id registered with this authorization server.
java.lang.String clientRegistrationEndpoint()

Get optional reference to a page where client or app registration for this authorization server is performed.
java.lang.String clientSecret()

Get client or app secret registered with this authorization server.
java.lang.String defaultScope()

Get access token scope that is going to be requested by default.
java.lang.String description()

Get description of the authorization server.
java.lang.String displayName()

Get user-friendly authorization server name.
java.util.List<GrantType> grantTypes()

Get form of an authorization grant, which the client uses to request the access token.
java.lang.String resourceOwnerPassword()

Get can be optionally specified when resource owner password grant type is supported by this authorization server.
java.lang.String resourceOwnerUsername()

Get can be optionally specified when resource owner password grant type is supported by this authorization server.
java.lang.Boolean supportState()

Get if true, authorization server will include state parameter from the authorization request to its response.
java.util.List<TokenBodyParameterContract> tokenBodyParameters()

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.
java.lang.String tokenEndpoint()

Get oAuth token endpoint.
AuthorizationServerUpdateContract withAuthorizationEndpoint(String authorizationEndpoint)

Set oAuth authorization endpoint.
AuthorizationServerUpdateContract withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

Set hTTP verbs supported by the authorization endpoint.
AuthorizationServerUpdateContract withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Set specifies the mechanism by which access token is passed to the API.
AuthorizationServerUpdateContract withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

Set method of authentication supported by the token endpoint of this authorization server.
AuthorizationServerUpdateContract withClientId(String clientId)

Set client or app id registered with this authorization server.
AuthorizationServerUpdateContract withClientRegistrationEndpoint(String clientRegistrationEndpoint)

Set optional reference to a page where client or app registration for this authorization server is performed.
AuthorizationServerUpdateContract withClientSecret(String clientSecret)

Set client or app secret registered with this authorization server.
AuthorizationServerUpdateContract withDefaultScope(String defaultScope)

Set access token scope that is going to be requested by default.
AuthorizationServerUpdateContract withDescription(String description)

Set description of the authorization server.
AuthorizationServerUpdateContract withDisplayName(String displayName)

Set user-friendly authorization server name.
AuthorizationServerUpdateContract withGrantTypes(List<GrantType> grantTypes)

Set form of an authorization grant, which the client uses to request the access token.
AuthorizationServerUpdateContract withResourceOwnerPassword(String resourceOwnerPassword)

Set can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerUpdateContract withResourceOwnerUsername(String resourceOwnerUsername)

Set can be optionally specified when resource owner password grant type is supported by this authorization server.
AuthorizationServerUpdateContract withSupportState(Boolean supportState)

Set if true, authorization server will include state parameter from the authorization request to its response.
AuthorizationServerUpdateContract withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

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.
AuthorizationServerUpdateContract withTokenEndpoint(String tokenEndpoint)

Set oAuth token endpoint.

Methods inherited from com.microsoft.azure.ProxyResource

com.microsoft.azure.ProxyResource.id com.microsoft.azure.ProxyResource.name com.microsoft.azure.ProxyResource.type

Methods inherited from java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

Constructor Details

AuthorizationServerUpdateContract

public AuthorizationServerUpdateContract()

Method Details

authorizationEndpoint

public String authorizationEndpoint()

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

Returns:

the authorizationEndpoint value

authorizationMethods

public List<AuthorizationMethod> authorizationMethods()

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

Returns:

the authorizationMethods value

bearerTokenSendingMethods

public List<BearerTokenSendingMethod> bearerTokenSendingMethods()

Get specifies the mechanism by which access token is passed to the API.

Returns:

the bearerTokenSendingMethods value

clientAuthenticationMethod

public List<ClientAuthenticationMethod> clientAuthenticationMethod()

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:

the clientAuthenticationMethod value

clientId

public String clientId()

Get client or app id registered with this authorization server.

Returns:

the clientId value

clientRegistrationEndpoint

public String clientRegistrationEndpoint()

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:

the clientRegistrationEndpoint value

clientSecret

public String clientSecret()

Get client or app secret registered with this authorization server.

Returns:

the clientSecret value

defaultScope

public String defaultScope()

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:

the defaultScope value

description

public String description()

Get description of the authorization server. Can contain HTML formatting tags.

Returns:

the description value

displayName

public String displayName()

Get user-friendly authorization server name.

Returns:

the displayName value

grantTypes

public List<GrantType> grantTypes()

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

Returns:

the grantTypes value

resourceOwnerPassword

public String resourceOwnerPassword()

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

Returns:

the resourceOwnerPassword value

resourceOwnerUsername

public String resourceOwnerUsername()

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

Returns:

the resourceOwnerUsername value

supportState

public Boolean supportState()

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:

the supportState value

tokenBodyParameters

public List<TokenBodyParameterContract> tokenBodyParameters()

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:

the tokenBodyParameters value

tokenEndpoint

public String tokenEndpoint()

Get oAuth token endpoint. Contains absolute URI to entity being referenced.

Returns:

the tokenEndpoint value

withAuthorizationEndpoint

public AuthorizationServerUpdateContract withAuthorizationEndpoint(String authorizationEndpoint)

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

Parameters:

authorizationEndpoint - the authorizationEndpoint value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withAuthorizationMethods

public AuthorizationServerUpdateContract withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)

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

Parameters:

authorizationMethods - the authorizationMethods value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withBearerTokenSendingMethods

public AuthorizationServerUpdateContract withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)

Set specifies the mechanism by which access token is passed to the API.

Parameters:

bearerTokenSendingMethods - the bearerTokenSendingMethods value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withClientAuthenticationMethod

public AuthorizationServerUpdateContract withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)

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.

Parameters:

clientAuthenticationMethod - the clientAuthenticationMethod value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withClientId

public AuthorizationServerUpdateContract withClientId(String clientId)

Set client or app id registered with this authorization server.

Parameters:

clientId - the clientId value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withClientRegistrationEndpoint

public AuthorizationServerUpdateContract withClientRegistrationEndpoint(String clientRegistrationEndpoint)

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

Parameters:

clientRegistrationEndpoint - the clientRegistrationEndpoint value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withClientSecret

public AuthorizationServerUpdateContract withClientSecret(String clientSecret)

Set client or app secret registered with this authorization server.

Parameters:

clientSecret - the clientSecret value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withDefaultScope

public AuthorizationServerUpdateContract withDefaultScope(String defaultScope)

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.

Parameters:

defaultScope - the defaultScope value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withDescription

public AuthorizationServerUpdateContract withDescription(String description)

Set description of the authorization server. Can contain HTML formatting tags.

Parameters:

description - the description value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withDisplayName

public AuthorizationServerUpdateContract withDisplayName(String displayName)

Set user-friendly authorization server name.

Parameters:

displayName - the displayName value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withGrantTypes

public AuthorizationServerUpdateContract withGrantTypes(List<GrantType> grantTypes)

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

Parameters:

grantTypes - the grantTypes value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withResourceOwnerPassword

public AuthorizationServerUpdateContract withResourceOwnerPassword(String resourceOwnerPassword)

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

Parameters:

resourceOwnerPassword - the resourceOwnerPassword value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withResourceOwnerUsername

public AuthorizationServerUpdateContract withResourceOwnerUsername(String resourceOwnerUsername)

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

Parameters:

resourceOwnerUsername - the resourceOwnerUsername value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withSupportState

public AuthorizationServerUpdateContract withSupportState(Boolean supportState)

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.

Parameters:

supportState - the supportState value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withTokenBodyParameters

public AuthorizationServerUpdateContract withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)

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

Parameters:

tokenBodyParameters - the tokenBodyParameters value to set

Returns:

the AuthorizationServerUpdateContract object itself.

withTokenEndpoint

public AuthorizationServerUpdateContract withTokenEndpoint(String tokenEndpoint)

Set oAuth token endpoint. Contains absolute URI to entity being referenced.

Parameters:

tokenEndpoint - the tokenEndpoint value to set

Returns:

the AuthorizationServerUpdateContract object itself.

Applies to