Interface AuthorizationServerContract
-
public interface AuthorizationServerContract
An immutable client-side representation of AuthorizationServerContract.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static interface
AuthorizationServerContract.Definition
The entirety of the AuthorizationServerContract definition.static interface
AuthorizationServerContract.DefinitionStages
The AuthorizationServerContract definition stages.static interface
AuthorizationServerContract.Update
The template for AuthorizationServerContract update.static interface
AuthorizationServerContract.UpdateStages
The AuthorizationServerContract update stages.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description String
authorizationEndpoint()
Gets the authorizationEndpoint property: OAuth authorization endpoint.List<AuthorizationMethod>
authorizationMethods()
Gets the authorizationMethods property: HTTP verbs supported by the authorization endpoint.List<BearerTokenSendingMethod>
bearerTokenSendingMethods()
Gets the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.List<ClientAuthenticationMethod>
clientAuthenticationMethod()
Gets the clientAuthenticationMethod property: Method of authentication supported by the token endpoint of this authorization server.String
clientId()
Gets the clientId property: Client or app id registered with this authorization server.String
clientRegistrationEndpoint()
Gets the clientRegistrationEndpoint property: Optional reference to a page where client or app registration for this authorization server is performed.String
clientSecret()
Gets the clientSecret property: Client or app secret registered with this authorization server.String
defaultScope()
Gets the defaultScope property: Access token scope that is going to be requested by default.String
description()
Gets the description property: Description of the authorization server.String
displayName()
Gets the displayName property: User-friendly authorization server name.List<GrantType>
grantTypes()
Gets the grantTypes property: Form of an authorization grant, which the client uses to request the access token.String
id()
Gets the id property: Fully qualified resource Id for the resource.AuthorizationServerContractInner
innerModel()
Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.AuthorizationServerContractInner object.AuthorizationServerSecretsContract
listSecrets()
Gets the client secret details of the authorization server.com.azure.core.http.rest.Response<AuthorizationServerSecretsContract>
listSecretsWithResponse(com.azure.core.util.Context context)
Gets the client secret details of the authorization server.String
name()
Gets the name property: The name of the resource.AuthorizationServerContract
refresh()
Refreshes the resource to sync with Azure.AuthorizationServerContract
refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.String
resourceOwnerPassword()
Gets the resourceOwnerPassword property: Can be optionally specified when resource owner password grant type is supported by this authorization server.String
resourceOwnerUsername()
Gets the resourceOwnerUsername property: Can be optionally specified when resource owner password grant type is supported by this authorization server.Boolean
supportState()
Gets the supportState property: If true, authorization server will include state parameter from the authorization request to its response.List<TokenBodyParameterContract>
tokenBodyParameters()
Gets 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()
Gets the tokenEndpoint property: OAuth token endpoint.String
type()
Gets the type property: The type of the resource.AuthorizationServerContract.Update
update()
Begins update for the AuthorizationServerContract resource.
-
-
-
Method Detail
-
id
String id()
Gets the id property: Fully qualified resource Id for the resource.- Returns:
- the id value.
-
name
String name()
Gets the name property: The name of the resource.- Returns:
- the name value.
-
type
String type()
Gets the type property: The type of the resource.- Returns:
- the type value.
-
displayName
String displayName()
Gets the displayName property: User-friendly authorization server name.- Returns:
- the displayName value.
-
clientRegistrationEndpoint
String clientRegistrationEndpoint()
Gets 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.
-
authorizationEndpoint
String authorizationEndpoint()
Gets the authorizationEndpoint property: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.- Returns:
- the authorizationEndpoint value.
-
grantTypes
List<GrantType> grantTypes()
Gets the grantTypes property: Form of an authorization grant, which the client uses to request the access token.- Returns:
- the grantTypes value.
-
clientId
String clientId()
Gets the clientId property: Client or app id registered with this authorization server.- Returns:
- the clientId value.
-
clientSecret
String clientSecret()
Gets 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.
-
description
String description()
Gets the description property: Description of the authorization server. Can contain HTML formatting tags.- Returns:
- the description value.
-
authorizationMethods
List<AuthorizationMethod> authorizationMethods()
Gets the authorizationMethods property: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.- Returns:
- the authorizationMethods value.
-
clientAuthenticationMethod
List<ClientAuthenticationMethod> clientAuthenticationMethod()
Gets 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.
-
tokenBodyParameters
List<TokenBodyParameterContract> tokenBodyParameters()
Gets 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.
-
tokenEndpoint
String tokenEndpoint()
Gets the tokenEndpoint property: OAuth token endpoint. Contains absolute URI to entity being referenced.- Returns:
- the tokenEndpoint value.
-
supportState
Boolean supportState()
Gets 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.
-
defaultScope
String defaultScope()
Gets 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.
-
bearerTokenSendingMethods
List<BearerTokenSendingMethod> bearerTokenSendingMethods()
Gets the bearerTokenSendingMethods property: Specifies the mechanism by which access token is passed to the API.- Returns:
- the bearerTokenSendingMethods value.
-
resourceOwnerUsername
String resourceOwnerUsername()
Gets 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.
-
resourceOwnerPassword
String resourceOwnerPassword()
Gets 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.
-
innerModel
AuthorizationServerContractInner innerModel()
Gets the inner com.azure.resourcemanager.apimanagement.fluent.models.AuthorizationServerContractInner object.- Returns:
- the inner object.
-
update
AuthorizationServerContract.Update update()
Begins update for the AuthorizationServerContract resource.- Returns:
- the stage of resource update.
-
refresh
AuthorizationServerContract refresh()
Refreshes the resource to sync with Azure.- Returns:
- the refreshed resource.
-
refresh
AuthorizationServerContract refresh(com.azure.core.util.Context context)
Refreshes the resource to sync with Azure.- Parameters:
context
- The context to associate with this operation.- Returns:
- the refreshed resource.
-
listSecrets
AuthorizationServerSecretsContract listSecrets()
Gets the client secret details of the authorization server.- Returns:
- the client secret details of the authorization server.
- Throws:
com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
listSecretsWithResponse
com.azure.core.http.rest.Response<AuthorizationServerSecretsContract> listSecretsWithResponse(com.azure.core.util.Context context)
Gets the client secret details of the authorization server.- Parameters:
context
- The context to associate with this operation.- Returns:
- the client secret details of the authorization server.
- Throws:
IllegalArgumentException
- thrown if parameters fail the validation.com.azure.core.management.exception.ManagementException
- thrown if the request is rejected by server.RuntimeException
- all other wrapped checked exceptions if the request fails to be sent.
-
-