Class AuthorizationServerContractInner
- java.lang.Object
-
- com.azure.core.management.ProxyResource
-
- com.azure.resourcemanager.apimanagement.fluent.models.AuthorizationServerContractInner
-
public final class AuthorizationServerContractInner extends com.azure.core.management.ProxyResource
External OAuth authorization server settings.
-
-
Constructor Summary
Constructors Constructor Description AuthorizationServerContractInner()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description String
authorizationEndpoint()
Get the authorizationEndpoint property: OAuth authorization endpoint.List<AuthorizationMethod>
authorizationMethods()
Get the authorizationMethods property: HTTP verbs supported by the authorization endpoint.List<BearerTokenSendingMethod>
bearerTokenSendingMethods()
Get the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.List<ClientAuthenticationMethod>
clientAuthenticationMethod()
Get the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server.String
clientId()
Get the clientId property: Client or app id registered with this authorization server.String
clientRegistrationEndpoint()
Get the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed.String
clientSecret()
Get the clientSecret property: Client or app secret registered with this authorization server.String
defaultScope()
Get the defaultScope property: Access token scope that is going to be requested by default.String
description()
Get the description property: Description of the authorization server.String
displayName()
Get the displayName property: User-friendly authorization server name.List<GrantType>
grantTypes()
Get the grantTypes property: Form of an authorization grant, which the client uses to request the access token.String
resourceOwnerPassword()
Get the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server.String
resourceOwnerUsername()
Get the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server.Boolean
supportState()
Get the supportState property: If true, authorization server will include state parameter from the authorization request to its response.List<TokenBodyParameterContract>
tokenBodyParameters()
Get the tokenBodyParameters property: 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.String
tokenEndpoint()
Get the tokenEndpoint property: OAuth token endpoint.void
validate()
Validates the instance.AuthorizationServerContractInner
withAuthorizationEndpoint(String authorizationEndpoint)
Set the authorizationEndpoint property: OAuth authorization endpoint.AuthorizationServerContractInner
withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)
Set the authorizationMethods property: HTTP verbs supported by the authorization endpoint.AuthorizationServerContractInner
withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)
Set the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.AuthorizationServerContractInner
withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)
Set the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server.AuthorizationServerContractInner
withClientId(String clientId)
Set the clientId property: Client or app id registered with this authorization server.AuthorizationServerContractInner
withClientRegistrationEndpoint(String clientRegistrationEndpoint)
Set the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed.AuthorizationServerContractInner
withClientSecret(String clientSecret)
Set the clientSecret property: Client or app secret registered with this authorization server.AuthorizationServerContractInner
withDefaultScope(String defaultScope)
Set the defaultScope property: Access token scope that is going to be requested by default.AuthorizationServerContractInner
withDescription(String description)
Set the description property: Description of the authorization server.AuthorizationServerContractInner
withDisplayName(String displayName)
Set the displayName property: User-friendly authorization server name.AuthorizationServerContractInner
withGrantTypes(List<GrantType> grantTypes)
Set the grantTypes property: Form of an authorization grant, which the client uses to request the access token.AuthorizationServerContractInner
withResourceOwnerPassword(String resourceOwnerPassword)
Set the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server.AuthorizationServerContractInner
withResourceOwnerUsername(String resourceOwnerUsername)
Set the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server.AuthorizationServerContractInner
withSupportState(Boolean supportState)
Set the supportState property: If true, authorization server will include state parameter from the authorization request to its response.AuthorizationServerContractInner
withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)
Set the tokenBodyParameters property: 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.AuthorizationServerContractInner
withTokenEndpoint(String tokenEndpoint)
Set the tokenEndpoint property: OAuth token endpoint.
-
-
-
Method Detail
-
displayName
public String displayName()
Get the displayName property: User-friendly authorization server name.- Returns:
- the displayName value.
-
withDisplayName
public AuthorizationServerContractInner withDisplayName(String displayName)
Set the displayName property: User-friendly authorization server name.- Parameters:
displayName
- the displayName value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
clientRegistrationEndpoint
public String clientRegistrationEndpoint()
Get the clientRegistrationEndpoint property: 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.
-
withClientRegistrationEndpoint
public AuthorizationServerContractInner withClientRegistrationEndpoint(String clientRegistrationEndpoint)
Set the clientRegistrationEndpoint property: 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 AuthorizationServerContractInner object itself.
-
authorizationEndpoint
public String authorizationEndpoint()
Get the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.- Returns:
- the authorizationEndpoint value.
-
withAuthorizationEndpoint
public AuthorizationServerContractInner withAuthorizationEndpoint(String authorizationEndpoint)
Set the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.- Parameters:
authorizationEndpoint
- the authorizationEndpoint value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
grantTypes
public List<GrantType> grantTypes()
Get the grantTypes property: Form of an authorization grant, which the client uses to request the access token.- Returns:
- the grantTypes value.
-
withGrantTypes
public AuthorizationServerContractInner withGrantTypes(List<GrantType> grantTypes)
Set the grantTypes property: Form of an authorization grant, which the client uses to request the access token.- Parameters:
grantTypes
- the grantTypes value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
clientId
public String clientId()
Get the clientId property: Client or app id registered with this authorization server.- Returns:
- the clientId value.
-
withClientId
public AuthorizationServerContractInner withClientId(String clientId)
Set the clientId property: Client or app id registered with this authorization server.- Parameters:
clientId
- the clientId value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
clientSecret
public String clientSecret()
Get the clientSecret property: 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.- Returns:
- the clientSecret value.
-
withClientSecret
public AuthorizationServerContractInner withClientSecret(String clientSecret)
Set the clientSecret property: 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.- Parameters:
clientSecret
- the clientSecret value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
description
public String description()
Get the description property: Description of the authorization server. Can contain HTML formatting tags.- Returns:
- the description value.
-
withDescription
public AuthorizationServerContractInner withDescription(String description)
Set the description property: Description of the authorization server. Can contain HTML formatting tags.- Parameters:
description
- the description value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
authorizationMethods
public List<AuthorizationMethod> authorizationMethods()
Get the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.- Returns:
- the authorizationMethods value.
-
withAuthorizationMethods
public AuthorizationServerContractInner withAuthorizationMethods(List<AuthorizationMethod> authorizationMethods)
Set the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.- Parameters:
authorizationMethods
- the authorizationMethods value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
clientAuthenticationMethod
public List<ClientAuthenticationMethod> clientAuthenticationMethod()
Get the clientAuthenticationMethod property: 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.
-
withClientAuthenticationMethod
public AuthorizationServerContractInner withClientAuthenticationMethod(List<ClientAuthenticationMethod> clientAuthenticationMethod)
Set the clientAuthenticationMethod property: 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 AuthorizationServerContractInner object itself.
-
tokenBodyParameters
public List<TokenBodyParameterContract> tokenBodyParameters()
Get the tokenBodyParameters property: 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.
-
withTokenBodyParameters
public AuthorizationServerContractInner withTokenBodyParameters(List<TokenBodyParameterContract> tokenBodyParameters)
Set the tokenBodyParameters property: 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 AuthorizationServerContractInner object itself.
-
tokenEndpoint
public String tokenEndpoint()
Get the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.- Returns:
- the tokenEndpoint value.
-
withTokenEndpoint
public AuthorizationServerContractInner withTokenEndpoint(String tokenEndpoint)
Set the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.- Parameters:
tokenEndpoint
- the tokenEndpoint value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
supportState
public Boolean supportState()
Get the supportState property: 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.
-
withSupportState
public AuthorizationServerContractInner withSupportState(Boolean supportState)
Set the supportState property: 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 AuthorizationServerContractInner object itself.
-
defaultScope
public String defaultScope()
Get the defaultScope property: 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.
-
withDefaultScope
public AuthorizationServerContractInner withDefaultScope(String defaultScope)
Set the defaultScope property: 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 AuthorizationServerContractInner object itself.
-
bearerTokenSendingMethods
public List<BearerTokenSendingMethod> bearerTokenSendingMethods()
Get the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.- Returns:
- the bearerTokenSendingMethods value.
-
withBearerTokenSendingMethods
public AuthorizationServerContractInner withBearerTokenSendingMethods(List<BearerTokenSendingMethod> bearerTokenSendingMethods)
Set the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.- Parameters:
bearerTokenSendingMethods
- the bearerTokenSendingMethods value to set.- Returns:
- the AuthorizationServerContractInner object itself.
-
resourceOwnerUsername
public String resourceOwnerUsername()
Get the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.- Returns:
- the resourceOwnerUsername value.
-
withResourceOwnerUsername
public AuthorizationServerContractInner withResourceOwnerUsername(String resourceOwnerUsername)
Set the resourceOwnerUsername property: 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 AuthorizationServerContractInner object itself.
-
resourceOwnerPassword
public String resourceOwnerPassword()
Get the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.- Returns:
- the resourceOwnerPassword value.
-
withResourceOwnerPassword
public AuthorizationServerContractInner withResourceOwnerPassword(String resourceOwnerPassword)
Set the resourceOwnerPassword property: 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 AuthorizationServerContractInner object itself.
-
validate
public void validate()
Validates the instance.- Throws:
IllegalArgumentException
- thrown if the instance is not valid.
-
-