onelogin
AuthServer
Creates an Authentication Server Resource.
This resource allows you to create and configure an Authentication Server.
Example Usage
using Pulumi;
using Onelogin = Pulumi.Onelogin;
class MyStack : Stack
{
public MyStack()
{
var example = new Onelogin.AuthServer("example", new Onelogin.AuthServerArgs
{
Configuration = new Onelogin.Inputs.AuthServerConfigurationArgs
{
AccessTokenExpirationMinutes = 10,
Audiences =
{
"https://example.com/contacts",
},
RefreshTokenExpirationMinutes = 30,
ResourceIdentifier = "https://example.com/contacts",
},
Description = "This is an api",
});
}
}
package main
import (
"github.com/pulumi/pulumi-onelogin/sdk/go/onelogin"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := onelogin.NewAuthServer(ctx, "example", &onelogin.AuthServerArgs{
Configuration: &AuthServerConfigurationArgs{
AccessTokenExpirationMinutes: pulumi.Int(10),
Audiences: pulumi.StringArray{
pulumi.String("https://example.com/contacts"),
},
RefreshTokenExpirationMinutes: pulumi.Int(30),
ResourceIdentifier: pulumi.String("https://example.com/contacts"),
},
Description: pulumi.String("This is an api"),
})
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_onelogin as onelogin
example = onelogin.AuthServer("example",
configuration=onelogin.AuthServerConfigurationArgs(
access_token_expiration_minutes=10,
audiences=["https://example.com/contacts"],
refresh_token_expiration_minutes=30,
resource_identifier="https://example.com/contacts",
),
description="This is an api")
import * as pulumi from "@pulumi/pulumi";
import * as onelogin from "@pulumi/onelogin";
const example = new onelogin.AuthServer("example", {
configuration: {
accessTokenExpirationMinutes: 10,
audiences: ["https://example.com/contacts"],
refreshTokenExpirationMinutes: 30,
resourceIdentifier: "https://example.com/contacts",
},
description: "This is an api",
});
Coming soon!
Create a AuthServer Resource
new AuthServer(name: string, args: AuthServerArgs, opts?: CustomResourceOptions);
@overload
def AuthServer(resource_name: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[AuthServerConfigurationArgs] = None,
description: Optional[str] = None,
name: Optional[str] = None)
@overload
def AuthServer(resource_name: str,
args: AuthServerArgs,
opts: Optional[ResourceOptions] = None)
func NewAuthServer(ctx *Context, name string, args AuthServerArgs, opts ...ResourceOption) (*AuthServer, error)
public AuthServer(string name, AuthServerArgs args, CustomResourceOptions? opts = null)
public AuthServer(String name, AuthServerArgs args)
public AuthServer(String name, AuthServerArgs args, CustomResourceOptions options)
type: onelogin:AuthServer
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthServerArgs
- 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 AuthServerArgs
- 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 AuthServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args AuthServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args AuthServerArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
AuthServer 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 AuthServer resource accepts the following input properties:
- Configuration
Auth
Server Configuration Args Configuration parameters
- Description string
A brief description about the resource.
- Name string
The resource's name.
- Configuration
Auth
Server Configuration Args Configuration parameters
- Description string
A brief description about the resource.
- Name string
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description String
A brief description about the resource.
- name String
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description string
A brief description about the resource.
- name string
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description str
A brief description about the resource.
- name str
The resource's name.
- configuration Property Map
Configuration parameters
- description String
A brief description about the resource.
- name String
The resource's name.
Outputs
All input properties are implicitly available as output properties. Additionally, the AuthServer resource produces the following output properties:
- Id string
The provider-assigned unique ID for this managed resource.
- Id string
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
- id string
The provider-assigned unique ID for this managed resource.
- id str
The provider-assigned unique ID for this managed resource.
- id String
The provider-assigned unique ID for this managed resource.
Look up an Existing AuthServer Resource
Get an existing AuthServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: AuthServerState, opts?: CustomResourceOptions): AuthServer
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
configuration: Optional[AuthServerConfigurationArgs] = None,
description: Optional[str] = None,
name: Optional[str] = None) -> AuthServer
func GetAuthServer(ctx *Context, name string, id IDInput, state *AuthServerState, opts ...ResourceOption) (*AuthServer, error)
public static AuthServer Get(string name, Input<string> id, AuthServerState? state, CustomResourceOptions? opts = null)
public static AuthServer get(String name, Output<String> id, AuthServerState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Configuration
Auth
Server Configuration Args Configuration parameters
- Description string
A brief description about the resource.
- Name string
The resource's name.
- Configuration
Auth
Server Configuration Args Configuration parameters
- Description string
A brief description about the resource.
- Name string
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description String
A brief description about the resource.
- name String
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description string
A brief description about the resource.
- name string
The resource's name.
- configuration
Auth
Server Configuration Args Configuration parameters
- description str
A brief description about the resource.
- name str
The resource's name.
- configuration Property Map
Configuration parameters
- description String
A brief description about the resource.
- name String
The resource's name.
Supporting Types
AuthServerConfiguration
- Audiences List<string>
List of API endpoints that will be returned in Access Tokens.
- Resource
Identifier string Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- Access
Token intExpiration Minutes The number of minutes until the token expires
- Refresh
Token intExpiration Minutes The number of minutes until the token expires
- Audiences []string
List of API endpoints that will be returned in Access Tokens.
- Resource
Identifier string Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- Access
Token intExpiration Minutes The number of minutes until the token expires
- Refresh
Token intExpiration Minutes The number of minutes until the token expires
- audiences List<String>
List of API endpoints that will be returned in Access Tokens.
- resource
Identifier String Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- access
Token IntegerExpiration Minutes The number of minutes until the token expires
- refresh
Token IntegerExpiration Minutes The number of minutes until the token expires
- audiences string[]
List of API endpoints that will be returned in Access Tokens.
- resource
Identifier string Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- access
Token numberExpiration Minutes The number of minutes until the token expires
- refresh
Token numberExpiration Minutes The number of minutes until the token expires
- audiences Sequence[str]
List of API endpoints that will be returned in Access Tokens.
- resource_
identifier str Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- access_
token_ intexpiration_ minutes The number of minutes until the token expires
- refresh_
token_ intexpiration_ minutes The number of minutes until the token expires
- audiences List<String>
List of API endpoints that will be returned in Access Tokens.
- resource
Identifier String Unique identifier for the API that the Authorization Server will issue Access Tokens for.
- access
Token NumberExpiration Minutes The number of minutes until the token expires
- refresh
Token NumberExpiration Minutes The number of minutes until the token expires
Import
An Auth Server can be imported via the OneLogin Auth Server ID.
$ pulumi import onelogin:index/authServer:AuthServer example <auth_server_id>
Package Details
- Repository
- https://github.com/pulumi/pulumi-onelogin
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
onelogin
Terraform Provider.