Docs Packages
  1. Packages
  2. onelogin
  3. API Docs
  4. AuthServers
onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-onelogin

onelogin.AuthServers

Explore with Pulumi AI

onelogin logo
onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
pulumi/pulumi-onelogin

    Create AuthServers Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthServers(name: string, args: AuthServersArgs, opts?: CustomResourceOptions);
    @overload
def AuthServers(resource_name: str,
                args: AuthServersArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AuthServers(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                configuration: Optional[AuthServersConfigurationArgs] = None,
                description: Optional[str] = None,
                name: Optional[str] = None)
    func NewAuthServers(ctx *Context, name string, args AuthServersArgs, opts ...ResourceOption) (*AuthServers, error)
    public AuthServers(string name, AuthServersArgs args, CustomResourceOptions? opts = null)
    public AuthServers(String name, AuthServersArgs args)
public AuthServers(String name, AuthServersArgs args, CustomResourceOptions options)

    type: onelogin:AuthServers
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 AuthServersArgs
    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 AuthServersArgs
    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 AuthServersArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthServersArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthServersArgs
    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 authServersResource = new Onelogin.AuthServers("authServersResource", new()
{
    Configuration = new Onelogin.Inputs.AuthServersConfigurationArgs
    {
        Audiences = new[]
        {
            "string",
        },
        ResourceIdentifier = "string",
        AccessTokenExpirationMinutes = 0,
        RefreshTokenExpirationMinutes = 0,
    },
    Description = "string",
    Name = "string",
});

    example, err := onelogin.NewAuthServers(ctx, "authServersResource", &onelogin.AuthServersArgs{
	Configuration: &onelogin.AuthServersConfigurationArgs{
		Audiences: pulumi.StringArray{
			pulumi.String("string"),
		},
		ResourceIdentifier:            pulumi.String("string"),
		AccessTokenExpirationMinutes:  pulumi.Int(0),
		RefreshTokenExpirationMinutes: pulumi.Int(0),
	},
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
})

    var authServersResource = new AuthServers("authServersResource", AuthServersArgs.builder()
    .configuration(AuthServersConfigurationArgs.builder()
        .audiences("string")
        .resourceIdentifier("string")
        .accessTokenExpirationMinutes(0)
        .refreshTokenExpirationMinutes(0)
        .build())
    .description("string")
    .name("string")
    .build());

    auth_servers_resource = onelogin.AuthServers("authServersResource",
    configuration=onelogin.AuthServersConfigurationArgs(
        audiences=["string"],
        resource_identifier="string",
        access_token_expiration_minutes=0,
        refresh_token_expiration_minutes=0,
    ),
    description="string",
    name="string")

    const authServersResource = new onelogin.AuthServers("authServersResource", {
    configuration: {
        audiences: ["string"],
        resourceIdentifier: "string",
        accessTokenExpirationMinutes: 0,
        refreshTokenExpirationMinutes: 0,
    },
    description: "string",
    name: "string",
});

    type: onelogin:AuthServers
properties:
    configuration:
        accessTokenExpirationMinutes: 0
        audiences:
            - string
        refreshTokenExpirationMinutes: 0
        resourceIdentifier: string
    description: string
    name: string

    AuthServers 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 AuthServers resource accepts the following input properties:

    Configuration AuthServersConfiguration
    Authorization server configuration
    Description string
    Description of what the API does.
    Name string
    Name of the API.
    Configuration AuthServersConfigurationArgs
    Authorization server configuration
    Description string
    Description of what the API does.
    Name string
    Name of the API.
    configuration AuthServersConfiguration
    Authorization server configuration
    description String
    Description of what the API does.
    name String
    Name of the API.
    configuration AuthServersConfiguration
    Authorization server configuration
    description string
    Description of what the API does.
    name string
    Name of the API.
    configuration AuthServersConfigurationArgs
    Authorization server configuration
    description str
    Description of what the API does.
    name str
    Name of the API.
    configuration Property Map
    Authorization server configuration
    description String
    Description of what the API does.
    name String
    Name of the API.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthServers 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 Existing AuthServers Resource

    Get an existing AuthServers 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?: AuthServersState, opts?: CustomResourceOptions): AuthServers
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configuration: Optional[AuthServersConfigurationArgs] = None,
        description: Optional[str] = None,
        name: Optional[str] = None) -> AuthServers
    func GetAuthServers(ctx *Context, name string, id IDInput, state *AuthServersState, opts ...ResourceOption) (*AuthServers, error)
    public static AuthServers Get(string name, Input<string> id, AuthServersState? state, CustomResourceOptions? opts = null)
    public static AuthServers get(String name, Output<String> id, AuthServersState 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.
    The following state arguments are supported:
    Configuration AuthServersConfiguration
    Authorization server configuration
    Description string
    Description of what the API does.
    Name string
    Name of the API.
    Configuration AuthServersConfigurationArgs
    Authorization server configuration
    Description string
    Description of what the API does.
    Name string
    Name of the API.
    configuration AuthServersConfiguration
    Authorization server configuration
    description String
    Description of what the API does.
    name String
    Name of the API.
    configuration AuthServersConfiguration
    Authorization server configuration
    description string
    Description of what the API does.
    name string
    Name of the API.
    configuration AuthServersConfigurationArgs
    Authorization server configuration
    description str
    Description of what the API does.
    name str
    Name of the API.
    configuration Property Map
    Authorization server configuration
    description String
    Description of what the API does.
    name String
    Name of the API.

    Supporting Types

    AuthServersConfiguration, AuthServersConfigurationArgs

    Audiences List<string>
    List of API endpoints that will be returned in Access Tokens.
    ResourceIdentifier string
    Unique identifier for the API that the Authorization Server will issue Access Tokens for.
    AccessTokenExpirationMinutes int
    The number of minutes until access token expires. There is no maximum expiry limit.
    RefreshTokenExpirationMinutes int
    The number of minutes until refresh token expires. There is no maximum expiry limit.
    Audiences []string
    List of API endpoints that will be returned in Access Tokens.
    ResourceIdentifier string
    Unique identifier for the API that the Authorization Server will issue Access Tokens for.
    AccessTokenExpirationMinutes int
    The number of minutes until access token expires. There is no maximum expiry limit.
    RefreshTokenExpirationMinutes int
    The number of minutes until refresh token expires. There is no maximum expiry limit.
    audiences List<String>
    List of API endpoints that will be returned in Access Tokens.
    resourceIdentifier String
    Unique identifier for the API that the Authorization Server will issue Access Tokens for.
    accessTokenExpirationMinutes Integer
    The number of minutes until access token expires. There is no maximum expiry limit.
    refreshTokenExpirationMinutes Integer
    The number of minutes until refresh token expires. There is no maximum expiry limit.
    audiences string[]
    List of API endpoints that will be returned in Access Tokens.
    resourceIdentifier string
    Unique identifier for the API that the Authorization Server will issue Access Tokens for.
    accessTokenExpirationMinutes number
    The number of minutes until access token expires. There is no maximum expiry limit.
    refreshTokenExpirationMinutes number
    The number of minutes until refresh token expires. There is no maximum expiry limit.
    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_expiration_minutes int
    The number of minutes until access token expires. There is no maximum expiry limit.
    refresh_token_expiration_minutes int
    The number of minutes until refresh token expires. There is no maximum expiry limit.
    audiences List<String>
    List of API endpoints that will be returned in Access Tokens.
    resourceIdentifier String
    Unique identifier for the API that the Authorization Server will issue Access Tokens for.
    accessTokenExpirationMinutes Number
    The number of minutes until access token expires. There is no maximum expiry limit.
    refreshTokenExpirationMinutes Number
    The number of minutes until refresh token expires. There is no maximum expiry limit.

    Package Details

    Repository
    onelogin pulumi/pulumi-onelogin
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the onelogin Terraform Provider.
    onelogin logo
    onelogin v0.6.3 published on Friday, May 10, 2024 by Pulumi
    pulumi/pulumi-onelogin