azure-native.apimanagement.AuthorizationServer
Explore with Pulumi AI
External OAuth authorization server settings. Azure REST API version: 2022-08-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview.
Example Usage
ApiManagementCreateAuthorizationServer
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() => 
{
    var authorizationServer = new AzureNative.ApiManagement.AuthorizationServer("authorizationServer", new()
    {
        AuthorizationEndpoint = "https://www.contoso.com/oauth2/auth",
        AuthorizationMethods = new[]
        {
            AzureNative.ApiManagement.AuthorizationMethod.GET,
        },
        Authsid = "newauthServer",
        BearerTokenSendingMethods = new[]
        {
            AzureNative.ApiManagement.BearerTokenSendingMethod.AuthorizationHeader,
        },
        ClientId = "1",
        ClientRegistrationEndpoint = "https://www.contoso.com/apps",
        ClientSecret = "2",
        DefaultScope = "read write",
        Description = "test server",
        DisplayName = "test2",
        GrantTypes = new[]
        {
            AzureNative.ApiManagement.GrantType.AuthorizationCode,
            AzureNative.ApiManagement.GrantType.@Implicit,
        },
        ResourceGroupName = "rg1",
        ResourceOwnerPassword = "pwd",
        ResourceOwnerUsername = "un",
        ServiceName = "apimService1",
        SupportState = true,
        TokenEndpoint = "https://www.contoso.com/oauth2/token",
        UseInApiDocumentation = true,
        UseInTestConsole = false,
    });
});
package main
import (
	apimanagement "github.com/pulumi/pulumi-azure-native-sdk/apimanagement/v2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := apimanagement.NewAuthorizationServer(ctx, "authorizationServer", &apimanagement.AuthorizationServerArgs{
			AuthorizationEndpoint: pulumi.String("https://www.contoso.com/oauth2/auth"),
			AuthorizationMethods: apimanagement.AuthorizationMethodArray{
				apimanagement.AuthorizationMethodGET,
			},
			Authsid: pulumi.String("newauthServer"),
			BearerTokenSendingMethods: pulumi.StringArray{
				pulumi.String(apimanagement.BearerTokenSendingMethodAuthorizationHeader),
			},
			ClientId:                   pulumi.String("1"),
			ClientRegistrationEndpoint: pulumi.String("https://www.contoso.com/apps"),
			ClientSecret:               pulumi.String("2"),
			DefaultScope:               pulumi.String("read write"),
			Description:                pulumi.String("test server"),
			DisplayName:                pulumi.String("test2"),
			GrantTypes: pulumi.StringArray{
				pulumi.String(apimanagement.GrantTypeAuthorizationCode),
				pulumi.String(apimanagement.GrantTypeImplicit),
			},
			ResourceGroupName:     pulumi.String("rg1"),
			ResourceOwnerPassword: pulumi.String("pwd"),
			ResourceOwnerUsername: pulumi.String("un"),
			ServiceName:           pulumi.String("apimService1"),
			SupportState:          pulumi.Bool(true),
			TokenEndpoint:         pulumi.String("https://www.contoso.com/oauth2/token"),
			UseInApiDocumentation: pulumi.Bool(true),
			UseInTestConsole:      pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.apimanagement.AuthorizationServer;
import com.pulumi.azurenative.apimanagement.AuthorizationServerArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        var authorizationServer = new AuthorizationServer("authorizationServer", AuthorizationServerArgs.builder()
            .authorizationEndpoint("https://www.contoso.com/oauth2/auth")
            .authorizationMethods("GET")
            .authsid("newauthServer")
            .bearerTokenSendingMethods("authorizationHeader")
            .clientId("1")
            .clientRegistrationEndpoint("https://www.contoso.com/apps")
            .clientSecret("2")
            .defaultScope("read write")
            .description("test server")
            .displayName("test2")
            .grantTypes(            
                "authorizationCode",
                "implicit")
            .resourceGroupName("rg1")
            .resourceOwnerPassword("pwd")
            .resourceOwnerUsername("un")
            .serviceName("apimService1")
            .supportState(true)
            .tokenEndpoint("https://www.contoso.com/oauth2/token")
            .useInApiDocumentation(true)
            .useInTestConsole(false)
            .build());
    }
}
import pulumi
import pulumi_azure_native as azure_native
authorization_server = azure_native.apimanagement.AuthorizationServer("authorizationServer",
    authorization_endpoint="https://www.contoso.com/oauth2/auth",
    authorization_methods=[azure_native.apimanagement.AuthorizationMethod.GET],
    authsid="newauthServer",
    bearer_token_sending_methods=[azure_native.apimanagement.BearerTokenSendingMethod.AUTHORIZATION_HEADER],
    client_id="1",
    client_registration_endpoint="https://www.contoso.com/apps",
    client_secret="2",
    default_scope="read write",
    description="test server",
    display_name="test2",
    grant_types=[
        azure_native.apimanagement.GrantType.AUTHORIZATION_CODE,
        azure_native.apimanagement.GrantType.IMPLICIT,
    ],
    resource_group_name="rg1",
    resource_owner_password="pwd",
    resource_owner_username="un",
    service_name="apimService1",
    support_state=True,
    token_endpoint="https://www.contoso.com/oauth2/token",
    use_in_api_documentation=True,
    use_in_test_console=False)
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const authorizationServer = new azure_native.apimanagement.AuthorizationServer("authorizationServer", {
    authorizationEndpoint: "https://www.contoso.com/oauth2/auth",
    authorizationMethods: [azure_native.apimanagement.AuthorizationMethod.GET],
    authsid: "newauthServer",
    bearerTokenSendingMethods: [azure_native.apimanagement.BearerTokenSendingMethod.AuthorizationHeader],
    clientId: "1",
    clientRegistrationEndpoint: "https://www.contoso.com/apps",
    clientSecret: "2",
    defaultScope: "read write",
    description: "test server",
    displayName: "test2",
    grantTypes: [
        azure_native.apimanagement.GrantType.AuthorizationCode,
        azure_native.apimanagement.GrantType.Implicit,
    ],
    resourceGroupName: "rg1",
    resourceOwnerPassword: "pwd",
    resourceOwnerUsername: "un",
    serviceName: "apimService1",
    supportState: true,
    tokenEndpoint: "https://www.contoso.com/oauth2/token",
    useInApiDocumentation: true,
    useInTestConsole: false,
});
resources:
  authorizationServer:
    type: azure-native:apimanagement:AuthorizationServer
    properties:
      authorizationEndpoint: https://www.contoso.com/oauth2/auth
      authorizationMethods:
        - GET
      authsid: newauthServer
      bearerTokenSendingMethods:
        - authorizationHeader
      clientId: '1'
      clientRegistrationEndpoint: https://www.contoso.com/apps
      clientSecret: '2'
      defaultScope: read write
      description: test server
      displayName: test2
      grantTypes:
        - authorizationCode
        - implicit
      resourceGroupName: rg1
      resourceOwnerPassword: pwd
      resourceOwnerUsername: un
      serviceName: apimService1
      supportState: true
      tokenEndpoint: https://www.contoso.com/oauth2/token
      useInApiDocumentation: true
      useInTestConsole: false
Create AuthorizationServer Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new AuthorizationServer(name: string, args: AuthorizationServerArgs, opts?: CustomResourceOptions);@overload
def AuthorizationServer(resource_name: str,
                        args: AuthorizationServerArgs,
                        opts: Optional[ResourceOptions] = None)
@overload
def AuthorizationServer(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        display_name: Optional[str] = None,
                        service_name: Optional[str] = None,
                        authorization_endpoint: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        grant_types: Optional[Sequence[Union[str, GrantType]]] = None,
                        client_id: Optional[str] = None,
                        client_registration_endpoint: Optional[str] = None,
                        client_authentication_method: Optional[Sequence[Union[str, ClientAuthenticationMethod]]] = None,
                        resource_owner_username: Optional[str] = None,
                        description: Optional[str] = None,
                        authsid: Optional[str] = None,
                        authorization_methods: Optional[Sequence[AuthorizationMethod]] = None,
                        bearer_token_sending_methods: Optional[Sequence[Union[str, BearerTokenSendingMethod]]] = None,
                        resource_owner_password: Optional[str] = None,
                        default_scope: Optional[str] = None,
                        client_secret: Optional[str] = None,
                        support_state: Optional[bool] = None,
                        token_body_parameters: Optional[Sequence[TokenBodyParameterContractArgs]] = None,
                        token_endpoint: Optional[str] = None,
                        use_in_api_documentation: Optional[bool] = None,
                        use_in_test_console: Optional[bool] = None)func NewAuthorizationServer(ctx *Context, name string, args AuthorizationServerArgs, opts ...ResourceOption) (*AuthorizationServer, error)public AuthorizationServer(string name, AuthorizationServerArgs args, CustomResourceOptions? opts = null)
public AuthorizationServer(String name, AuthorizationServerArgs args)
public AuthorizationServer(String name, AuthorizationServerArgs args, CustomResourceOptions options)
type: azure-native:apimanagement:AuthorizationServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args AuthorizationServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args AuthorizationServerArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args AuthorizationServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthorizationServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthorizationServerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var authorizationServerResource = new AzureNative.ApiManagement.AuthorizationServer("authorizationServerResource", new()
{
    DisplayName = "string",
    ServiceName = "string",
    AuthorizationEndpoint = "string",
    ResourceGroupName = "string",
    GrantTypes = new[]
    {
        "string",
    },
    ClientId = "string",
    ClientRegistrationEndpoint = "string",
    ClientAuthenticationMethod = new[]
    {
        "string",
    },
    ResourceOwnerUsername = "string",
    Description = "string",
    Authsid = "string",
    AuthorizationMethods = new[]
    {
        AzureNative.ApiManagement.AuthorizationMethod.HEAD,
    },
    BearerTokenSendingMethods = new[]
    {
        "string",
    },
    ResourceOwnerPassword = "string",
    DefaultScope = "string",
    ClientSecret = "string",
    SupportState = false,
    TokenBodyParameters = new[]
    {
        new AzureNative.ApiManagement.Inputs.TokenBodyParameterContractArgs
        {
            Name = "string",
            Value = "string",
        },
    },
    TokenEndpoint = "string",
    UseInApiDocumentation = false,
    UseInTestConsole = false,
});
example, err := apimanagement.NewAuthorizationServer(ctx, "authorizationServerResource", &apimanagement.AuthorizationServerArgs{
DisplayName: pulumi.String("string"),
ServiceName: pulumi.String("string"),
AuthorizationEndpoint: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
GrantTypes: pulumi.StringArray{
pulumi.String("string"),
},
ClientId: pulumi.String("string"),
ClientRegistrationEndpoint: pulumi.String("string"),
ClientAuthenticationMethod: pulumi.StringArray{
pulumi.String("string"),
},
ResourceOwnerUsername: pulumi.String("string"),
Description: pulumi.String("string"),
Authsid: pulumi.String("string"),
AuthorizationMethods: apimanagement.AuthorizationMethodArray{
apimanagement.AuthorizationMethodHEAD,
},
BearerTokenSendingMethods: pulumi.StringArray{
pulumi.String("string"),
},
ResourceOwnerPassword: pulumi.String("string"),
DefaultScope: pulumi.String("string"),
ClientSecret: pulumi.String("string"),
SupportState: pulumi.Bool(false),
TokenBodyParameters: apimanagement.TokenBodyParameterContractArray{
&apimanagement.TokenBodyParameterContractArgs{
Name: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
TokenEndpoint: pulumi.String("string"),
UseInApiDocumentation: pulumi.Bool(false),
UseInTestConsole: pulumi.Bool(false),
})
var authorizationServerResource = new AuthorizationServer("authorizationServerResource", AuthorizationServerArgs.builder()
    .displayName("string")
    .serviceName("string")
    .authorizationEndpoint("string")
    .resourceGroupName("string")
    .grantTypes("string")
    .clientId("string")
    .clientRegistrationEndpoint("string")
    .clientAuthenticationMethod("string")
    .resourceOwnerUsername("string")
    .description("string")
    .authsid("string")
    .authorizationMethods("HEAD")
    .bearerTokenSendingMethods("string")
    .resourceOwnerPassword("string")
    .defaultScope("string")
    .clientSecret("string")
    .supportState(false)
    .tokenBodyParameters(TokenBodyParameterContractArgs.builder()
        .name("string")
        .value("string")
        .build())
    .tokenEndpoint("string")
    .useInApiDocumentation(false)
    .useInTestConsole(false)
    .build());
authorization_server_resource = azure_native.apimanagement.AuthorizationServer("authorizationServerResource",
    display_name="string",
    service_name="string",
    authorization_endpoint="string",
    resource_group_name="string",
    grant_types=["string"],
    client_id="string",
    client_registration_endpoint="string",
    client_authentication_method=["string"],
    resource_owner_username="string",
    description="string",
    authsid="string",
    authorization_methods=[azure_native.apimanagement.AuthorizationMethod.HEAD],
    bearer_token_sending_methods=["string"],
    resource_owner_password="string",
    default_scope="string",
    client_secret="string",
    support_state=False,
    token_body_parameters=[azure_native.apimanagement.TokenBodyParameterContractArgs(
        name="string",
        value="string",
    )],
    token_endpoint="string",
    use_in_api_documentation=False,
    use_in_test_console=False)
const authorizationServerResource = new azure_native.apimanagement.AuthorizationServer("authorizationServerResource", {
    displayName: "string",
    serviceName: "string",
    authorizationEndpoint: "string",
    resourceGroupName: "string",
    grantTypes: ["string"],
    clientId: "string",
    clientRegistrationEndpoint: "string",
    clientAuthenticationMethod: ["string"],
    resourceOwnerUsername: "string",
    description: "string",
    authsid: "string",
    authorizationMethods: [azure_native.apimanagement.AuthorizationMethod.HEAD],
    bearerTokenSendingMethods: ["string"],
    resourceOwnerPassword: "string",
    defaultScope: "string",
    clientSecret: "string",
    supportState: false,
    tokenBodyParameters: [{
        name: "string",
        value: "string",
    }],
    tokenEndpoint: "string",
    useInApiDocumentation: false,
    useInTestConsole: false,
});
type: azure-native:apimanagement:AuthorizationServer
properties:
    authorizationEndpoint: string
    authorizationMethods:
        - HEAD
    authsid: string
    bearerTokenSendingMethods:
        - string
    clientAuthenticationMethod:
        - string
    clientId: string
    clientRegistrationEndpoint: string
    clientSecret: string
    defaultScope: string
    description: string
    displayName: string
    grantTypes:
        - string
    resourceGroupName: string
    resourceOwnerPassword: string
    resourceOwnerUsername: string
    serviceName: string
    supportState: false
    tokenBodyParameters:
        - name: string
          value: string
    tokenEndpoint: string
    useInApiDocumentation: false
    useInTestConsole: false
AuthorizationServer Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The AuthorizationServer resource accepts the following input properties:
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- ClientId string
- Client or app id registered with this authorization server.
- ClientRegistration stringEndpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- DisplayName string
- User-friendly authorization server name.
- GrantTypes List<Union<string, Pulumi.Azure Native. Api Management. Grant Type>> 
- Form of an authorization grant, which the client uses to request the access token.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- 
List<Pulumi.Azure Native. Api Management. Authorization Method> 
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- Authsid string
- Identifier of the authorization server.
- BearerToken List<Union<string, Pulumi.Sending Methods Azure Native. Api Management. Bearer Token Sending Method>> 
- Specifies the mechanism by which access token is passed to the API.
- ClientAuthentication List<Union<string, Pulumi.Method Azure Native. Api Management. Client Authentication Method>> 
- 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.
- ClientSecret string
- 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.
- DefaultScope string
- 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.
- Description string
- Description of the authorization server. Can contain HTML formatting tags.
- ResourceOwner stringPassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- ResourceOwner stringUsername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- SupportState bool
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- TokenBody List<Pulumi.Parameters Azure Native. Api Management. Inputs. Token Body Parameter Contract> 
- 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"}.
- TokenEndpoint string
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- UseIn boolApi Documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- UseIn boolTest Console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- ClientId string
- Client or app id registered with this authorization server.
- ClientRegistration stringEndpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- DisplayName string
- User-friendly authorization server name.
- GrantTypes []string
- Form of an authorization grant, which the client uses to request the access token.
- ResourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- ServiceName string
- The name of the API Management service.
- 
[]AuthorizationMethod 
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- Authsid string
- Identifier of the authorization server.
- BearerToken []stringSending Methods 
- Specifies the mechanism by which access token is passed to the API.
- ClientAuthentication []stringMethod 
- 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.
- ClientSecret string
- 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.
- DefaultScope string
- 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.
- Description string
- Description of the authorization server. Can contain HTML formatting tags.
- ResourceOwner stringPassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- ResourceOwner stringUsername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- SupportState bool
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- TokenBody []TokenParameters Body Parameter Contract Args 
- 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"}.
- TokenEndpoint string
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- UseIn boolApi Documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- UseIn boolTest Console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- String
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- clientId String
- Client or app id registered with this authorization server.
- clientRegistration StringEndpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- displayName String
- User-friendly authorization server name.
- grantTypes List<Either<String,GrantType>> 
- Form of an authorization grant, which the client uses to request the access token.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- 
List<AuthorizationMethod> 
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- authsid String
- Identifier of the authorization server.
- bearerToken List<Either<String,BearerSending Methods Token Sending Method>> 
- Specifies the mechanism by which access token is passed to the API.
- clientAuthentication List<Either<String,ClientMethod Authentication Method>> 
- 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.
- clientSecret String
- 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.
- defaultScope String
- 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.
- description String
- Description of the authorization server. Can contain HTML formatting tags.
- resourceOwner StringPassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resourceOwner StringUsername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- supportState Boolean
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- tokenBody List<TokenParameters Body Parameter Contract> 
- 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"}.
- tokenEndpoint String
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- useIn BooleanApi Documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- useIn BooleanTest Console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- clientId string
- Client or app id registered with this authorization server.
- clientRegistration stringEndpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- displayName string
- User-friendly authorization server name.
- grantTypes (string | GrantType)[] 
- Form of an authorization grant, which the client uses to request the access token.
- resourceGroup stringName 
- The name of the resource group. The name is case insensitive.
- serviceName string
- The name of the API Management service.
- 
AuthorizationMethod[] 
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- authsid string
- Identifier of the authorization server.
- bearerToken (string | BearerSending Methods Token Sending Method)[] 
- Specifies the mechanism by which access token is passed to the API.
- clientAuthentication (string | ClientMethod Authentication Method)[] 
- 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.
- clientSecret string
- 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.
- defaultScope string
- 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.
- description string
- Description of the authorization server. Can contain HTML formatting tags.
- resourceOwner stringPassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resourceOwner stringUsername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- supportState boolean
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- tokenBody TokenParameters Body Parameter Contract[] 
- 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"}.
- tokenEndpoint string
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- useIn booleanApi Documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- useIn booleanTest Console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- str
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- client_id str
- Client or app id registered with this authorization server.
- client_registration_ strendpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- display_name str
- User-friendly authorization server name.
- grant_types Sequence[Union[str, GrantType]] 
- Form of an authorization grant, which the client uses to request the access token.
- resource_group_ strname 
- The name of the resource group. The name is case insensitive.
- service_name str
- The name of the API Management service.
- 
Sequence[AuthorizationMethod] 
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- authsid str
- Identifier of the authorization server.
- bearer_token_ Sequence[Union[str, Bearersending_ methods Token Sending Method]] 
- Specifies the mechanism by which access token is passed to the API.
- client_authentication_ Sequence[Union[str, Clientmethod Authentication Method]] 
- 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.
- client_secret str
- 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.
- default_scope str
- 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.
- description str
- Description of the authorization server. Can contain HTML formatting tags.
- resource_owner_ strpassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resource_owner_ strusername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- support_state bool
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- token_body_ Sequence[Tokenparameters Body Parameter Contract Args] 
- 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"}.
- token_endpoint str
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- use_in_ boolapi_ documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- use_in_ booltest_ console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- String
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- clientId String
- Client or app id registered with this authorization server.
- clientRegistration StringEndpoint 
- Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
- displayName String
- User-friendly authorization server name.
- grantTypes List<String | "authorizationCode" | "implicit" | "resource Owner Password" | "client Credentials"> 
- Form of an authorization grant, which the client uses to request the access token.
- resourceGroup StringName 
- The name of the resource group. The name is case insensitive.
- serviceName String
- The name of the API Management service.
- List<"HEAD" | "OPTIONS" | "TRACE" | "GET" | "POST" | "PUT" | "PATCH" | "DELETE">
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- authsid String
- Identifier of the authorization server.
- bearerToken List<String | "authorizationSending Methods Header" | "query"> 
- Specifies the mechanism by which access token is passed to the API.
- clientAuthentication List<String | "Basic" | "Body">Method 
- 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.
- clientSecret String
- 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.
- defaultScope String
- 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.
- description String
- Description of the authorization server. Can contain HTML formatting tags.
- resourceOwner StringPassword 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resourceOwner StringUsername 
- Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- supportState Boolean
- If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
- tokenBody List<Property Map>Parameters 
- 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"}.
- tokenEndpoint String
- OAuth token endpoint. Contains absolute URI to entity being referenced.
- useIn BooleanApi Documentation 
- If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
- useIn BooleanTest Console 
- If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthorizationServer resource produces the following output properties:
Supporting Types
AuthorizationMethod, AuthorizationMethodArgs    
- HEAD
- HEAD
- OPTIONS
- OPTIONS
- TRACE
- TRACE
- GET
- GET
- POST
- POST
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- AuthorizationMethod HEAD 
- HEAD
- AuthorizationMethod OPTIONS 
- OPTIONS
- AuthorizationMethod TRACE 
- TRACE
- AuthorizationMethod GET 
- GET
- AuthorizationMethod POST 
- POST
- AuthorizationMethod PUT 
- PUT
- AuthorizationMethod PATCH 
- PATCH
- AuthorizationMethod DELETE 
- DELETE
- HEAD
- HEAD
- OPTIONS
- OPTIONS
- TRACE
- TRACE
- GET
- GET
- POST
- POST
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- HEAD
- HEAD
- OPTIONS
- OPTIONS
- TRACE
- TRACE
- GET
- GET
- POST
- POST
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- HEAD
- HEAD
- OPTIONS
- OPTIONS
- TRACE
- TRACE
- GET
- GET
- POST
- POST
- PUT
- PUT
- PATCH
- PATCH
- DELETE
- DELETE
- "HEAD"
- HEAD
- "OPTIONS"
- OPTIONS
- "TRACE"
- TRACE
- "GET"
- GET
- "POST"
- POST
- "PUT"
- PUT
- "PATCH"
- PATCH
- "DELETE"
- DELETE
BearerTokenSendingMethod, BearerTokenSendingMethodArgs        
- AuthorizationHeader 
- authorizationHeader
- Query
- query
- BearerToken Sending Method Authorization Header 
- authorizationHeader
- BearerToken Sending Method Query 
- query
- AuthorizationHeader 
- authorizationHeader
- Query
- query
- AuthorizationHeader 
- authorizationHeader
- Query
- query
- AUTHORIZATION_HEADER
- authorizationHeader
- QUERY
- query
- "authorizationHeader" 
- authorizationHeader
- "query"
- query
ClientAuthenticationMethod, ClientAuthenticationMethodArgs      
- Basic
- BasicBasic Client Authentication method.
- Body
- BodyBody based Authentication method.
- ClientAuthentication Method Basic 
- BasicBasic Client Authentication method.
- ClientAuthentication Method Body 
- BodyBody based Authentication method.
- Basic
- BasicBasic Client Authentication method.
- Body
- BodyBody based Authentication method.
- Basic
- BasicBasic Client Authentication method.
- Body
- BodyBody based Authentication method.
- BASIC
- BasicBasic Client Authentication method.
- BODY
- BodyBody based Authentication method.
- "Basic"
- BasicBasic Client Authentication method.
- "Body"
- BodyBody based Authentication method.
GrantType, GrantTypeArgs    
- AuthorizationCode 
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- @Implicit
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- ResourceOwner Password 
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- ClientCredentials 
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
- GrantType Authorization Code 
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- GrantType Implicit 
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- GrantType Resource Owner Password 
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- GrantType Client Credentials 
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
- AuthorizationCode 
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- Implicit
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- ResourceOwner Password 
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- ClientCredentials 
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
- AuthorizationCode 
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- Implicit
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- ResourceOwner Password 
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- ClientCredentials 
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
- AUTHORIZATION_CODE
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- IMPLICIT
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- RESOURCE_OWNER_PASSWORD
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- CLIENT_CREDENTIALS
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
- "authorizationCode" 
- authorizationCodeAuthorization Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.1.
- "implicit"
- implicitImplicit Code Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.2.
- "resourceOwner Password" 
- resourceOwnerPasswordResource Owner Password Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.3.
- "clientCredentials" 
- clientCredentialsClient Credentials Grant flow as described https://tools.ietf.org/html/rfc6749#section-4.4.
TokenBodyParameterContract, TokenBodyParameterContractArgs        
TokenBodyParameterContractResponse, TokenBodyParameterContractResponseArgs          
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:apimanagement:AuthorizationServer newauthServer /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid} 
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0