auth

package
v1.3.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 4, 2019 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GetServerArgs

type GetServerArgs struct {
	// The name of the auth server to retrieve.
	Name interface{}
}

A collection of arguments for invoking getServer.

type GetServerResult

type GetServerResult struct {
	// array of audiences,
	Audiences interface{}
	// last time credentials were rotated.
	CredentialsLastRotated interface{}
	// next time credentials will be rotated
	CredentialsNextRotation interface{}
	// mode of credential rotation, auto or manual.
	CredentialsRotationMode interface{}
	// description of Authorization server.
	Description interface{}
	// auth server key id.
	Kid interface{}
	// The name of the auth server.
	Name interface{}
	// the activation status of the authorization server.
	Status interface{}
	// id is the provider-assigned unique ID for this managed resource.
	Id interface{}
}

A collection of values returned by getServer.

func LookupServer

func LookupServer(ctx *pulumi.Context, args *GetServerArgs) (*GetServerResult, error)

Use this data source to retrieve an auth server from Okta.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/d/auth_server.html.markdown.

type Server

type Server struct {
	// contains filtered or unexported fields
}

Creates an Authorization Server.

This resource allows you to create and configure an Authorization Server.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/auth_server.html.markdown.

func GetServer

func GetServer(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerState, opts ...pulumi.ResourceOpt) (*Server, error)

GetServer gets an existing Server resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServer

func NewServer(ctx *pulumi.Context,
	name string, args *ServerArgs, opts ...pulumi.ResourceOpt) (*Server, error)

NewServer registers a new resource with the given unique name, arguments, and options.

func (*Server) Audiences

func (r *Server) Audiences() pulumi.ArrayOutput

The recipients that the tokens are intended for. This becomes the `aud` claim in an access token.

func (*Server) CredentialsLastRotated

func (r *Server) CredentialsLastRotated() pulumi.StringOutput

The timestamp when the authorization server started to use the `kid` for signing tokens.

func (*Server) CredentialsNextRotation

func (r *Server) CredentialsNextRotation() pulumi.StringOutput

The timestamp when the authorization server changes the key for signing tokens. Only returned when `credentialsRotationMode` is `"AUTO"`.

func (*Server) CredentialsRotationMode

func (r *Server) CredentialsRotationMode() pulumi.StringOutput

The key rotation mode for the authorization server. Can be `"AUTO"` or `"MANUAL"`.

func (*Server) Description

func (r *Server) Description() pulumi.StringOutput

The description of the authorization server.

func (*Server) ID

func (r *Server) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*Server) Issuer

func (r *Server) Issuer() pulumi.StringOutput

The complete URL for a Custom Authorization Server. This becomes the `iss` claim in an access token.

func (*Server) IssuerMode

func (r *Server) IssuerMode() pulumi.StringOutput

Allows you to use a custom issuer URL. It can be set to `"CUSTOM_URL"` or `"ORG_URL"`

func (*Server) Kid

func (r *Server) Kid() pulumi.StringOutput

The ID of the JSON Web Key used for signing tokens issued by the authorization server.

func (*Server) Name

func (r *Server) Name() pulumi.StringOutput

The name of the authorization server.

func (*Server) Status

func (r *Server) Status() pulumi.StringOutput

The status of the auth server. It defaults to `"ACTIVE"`

func (*Server) URN

func (r *Server) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ServerArgs

type ServerArgs struct {
	// The recipients that the tokens are intended for. This becomes the `aud` claim in an access token.
	Audiences interface{}
	// The key rotation mode for the authorization server. Can be `"AUTO"` or `"MANUAL"`.
	CredentialsRotationMode interface{}
	// The description of the authorization server.
	Description interface{}
	// Allows you to use a custom issuer URL. It can be set to `"CUSTOM_URL"` or `"ORG_URL"`
	IssuerMode interface{}
	// The name of the authorization server.
	Name interface{}
	// The status of the auth server. It defaults to `"ACTIVE"`
	Status interface{}
}

The set of arguments for constructing a Server resource.

type ServerClaim

type ServerClaim struct {
	// contains filtered or unexported fields
}

Creates an Authorization Server Claim.

This resource allows you to create and configure an Authorization Server Claim.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/auth_server_claim.html.markdown.

func GetServerClaim

func GetServerClaim(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerClaimState, opts ...pulumi.ResourceOpt) (*ServerClaim, error)

GetServerClaim gets an existing ServerClaim resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServerClaim

func NewServerClaim(ctx *pulumi.Context,
	name string, args *ServerClaimArgs, opts ...pulumi.ResourceOpt) (*ServerClaim, error)

NewServerClaim registers a new resource with the given unique name, arguments, and options.

func (*ServerClaim) AlwaysIncludeInToken

func (r *ServerClaim) AlwaysIncludeInToken() pulumi.BoolOutput

Specifies whether to include claims in token, by default is is set to `true`.

func (*ServerClaim) AuthServerId

func (r *ServerClaim) AuthServerId() pulumi.StringOutput

The Application's display name.

func (*ServerClaim) ClaimType

func (r *ServerClaim) ClaimType() pulumi.StringOutput

Specifies whether the claim is for an access token `"RESOURCE"` or ID token `"IDENTITY"`.

func (*ServerClaim) GroupFilterType

func (r *ServerClaim) GroupFilterType() pulumi.StringOutput

Specifies the type of group filter if `valueType` is `"GROUPS"`. Can be set to one of the following `"STARTS_WITH"`, `"EQUALS"`, `"CONTAINS"`, `"REGEX"`.

func (*ServerClaim) ID

func (r *ServerClaim) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ServerClaim) Name

func (r *ServerClaim) Name() pulumi.StringOutput

The name of the claim.

func (*ServerClaim) Scopes

func (r *ServerClaim) Scopes() pulumi.ArrayOutput

The list of scopes the auth server claim is tied to.

func (*ServerClaim) Status

func (r *ServerClaim) Status() pulumi.StringOutput

The status of the application. It defaults to `"ACTIVE"`.

func (*ServerClaim) URN

func (r *ServerClaim) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

func (*ServerClaim) Value

func (r *ServerClaim) Value() pulumi.StringOutput

The value of the claim.

func (*ServerClaim) ValueType

func (r *ServerClaim) ValueType() pulumi.StringOutput

The type of value of the claim. It can be set to `"EXPRESSION"` or `"GROUPS"`. It defaults to `"EXPRESSION"`.

type ServerClaimArgs

type ServerClaimArgs struct {
	// Specifies whether to include claims in token, by default is is set to `true`.
	AlwaysIncludeInToken interface{}
	// The Application's display name.
	AuthServerId interface{}
	// Specifies whether the claim is for an access token `"RESOURCE"` or ID token `"IDENTITY"`.
	ClaimType interface{}
	// Specifies the type of group filter if `valueType` is `"GROUPS"`. Can be set to one of the following `"STARTS_WITH"`, `"EQUALS"`, `"CONTAINS"`, `"REGEX"`.
	GroupFilterType interface{}
	// The name of the claim.
	Name interface{}
	// The list of scopes the auth server claim is tied to.
	Scopes interface{}
	// The status of the application. It defaults to `"ACTIVE"`.
	Status interface{}
	// The value of the claim.
	Value interface{}
	// The type of value of the claim. It can be set to `"EXPRESSION"` or `"GROUPS"`. It defaults to `"EXPRESSION"`.
	ValueType interface{}
}

The set of arguments for constructing a ServerClaim resource.

type ServerClaimState

type ServerClaimState struct {
	// Specifies whether to include claims in token, by default is is set to `true`.
	AlwaysIncludeInToken interface{}
	// The Application's display name.
	AuthServerId interface{}
	// Specifies whether the claim is for an access token `"RESOURCE"` or ID token `"IDENTITY"`.
	ClaimType interface{}
	// Specifies the type of group filter if `valueType` is `"GROUPS"`. Can be set to one of the following `"STARTS_WITH"`, `"EQUALS"`, `"CONTAINS"`, `"REGEX"`.
	GroupFilterType interface{}
	// The name of the claim.
	Name interface{}
	// The list of scopes the auth server claim is tied to.
	Scopes interface{}
	// The status of the application. It defaults to `"ACTIVE"`.
	Status interface{}
	// The value of the claim.
	Value interface{}
	// The type of value of the claim. It can be set to `"EXPRESSION"` or `"GROUPS"`. It defaults to `"EXPRESSION"`.
	ValueType interface{}
}

Input properties used for looking up and filtering ServerClaim resources.

type ServerPolicy

type ServerPolicy struct {
	// contains filtered or unexported fields
}

Creates an Authorization Server Policy.

This resource allows you to create and configure an Authorization Server Policy.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/auth_server_policy.html.markdown.

func GetServerPolicy

func GetServerPolicy(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerPolicyState, opts ...pulumi.ResourceOpt) (*ServerPolicy, error)

GetServerPolicy gets an existing ServerPolicy resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServerPolicy

func NewServerPolicy(ctx *pulumi.Context,
	name string, args *ServerPolicyArgs, opts ...pulumi.ResourceOpt) (*ServerPolicy, error)

NewServerPolicy registers a new resource with the given unique name, arguments, and options.

func (*ServerPolicy) AuthServerId

func (r *ServerPolicy) AuthServerId() pulumi.StringOutput

The ID of the Auth Server.

func (*ServerPolicy) ClientWhitelists

func (r *ServerPolicy) ClientWhitelists() pulumi.ArrayOutput

The clients to whitelist the policy for. `["ALL_CLIENTS"]` is a special value that can be used to whitelist for all clients. Otherwise it is a list of client ids.

func (*ServerPolicy) Description

func (r *ServerPolicy) Description() pulumi.StringOutput

The description of the Auth Server Policy.

func (*ServerPolicy) ID

func (r *ServerPolicy) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ServerPolicy) Name

func (r *ServerPolicy) Name() pulumi.StringOutput

The name of the Auth Server Policy.

func (*ServerPolicy) Priority

func (r *ServerPolicy) Priority() pulumi.IntOutput

The priority of the Auth Server Policy.

func (*ServerPolicy) Status

func (r *ServerPolicy) Status() pulumi.StringOutput

The status of the Auth Server Policy.

func (*ServerPolicy) Type

func (r *ServerPolicy) Type() pulumi.StringOutput

The type of the Auth Server Policy.

func (*ServerPolicy) URN

func (r *ServerPolicy) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ServerPolicyArgs

type ServerPolicyArgs struct {
	// The ID of the Auth Server.
	AuthServerId interface{}
	// The clients to whitelist the policy for. `["ALL_CLIENTS"]` is a special value that can be used to whitelist for all clients. Otherwise it is a list of client ids.
	ClientWhitelists interface{}
	// The description of the Auth Server Policy.
	Description interface{}
	// The name of the Auth Server Policy.
	Name interface{}
	// The priority of the Auth Server Policy.
	Priority interface{}
	// The status of the Auth Server Policy.
	Status interface{}
	// The type of the Auth Server Policy.
	Type interface{}
}

The set of arguments for constructing a ServerPolicy resource.

type ServerPolicyClaim

type ServerPolicyClaim struct {
	// contains filtered or unexported fields
}

Creates an Authorization Server Policy Rule.

This resource allows you to create and configure an Authorization Server Policy Rule.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/auth_server_policy_rule.html.markdown.

func GetServerPolicyClaim

func GetServerPolicyClaim(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerPolicyClaimState, opts ...pulumi.ResourceOpt) (*ServerPolicyClaim, error)

GetServerPolicyClaim gets an existing ServerPolicyClaim resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServerPolicyClaim

func NewServerPolicyClaim(ctx *pulumi.Context,
	name string, args *ServerPolicyClaimArgs, opts ...pulumi.ResourceOpt) (*ServerPolicyClaim, error)

NewServerPolicyClaim registers a new resource with the given unique name, arguments, and options.

func (*ServerPolicyClaim) AccessTokenLifetimeMinutes

func (r *ServerPolicyClaim) AccessTokenLifetimeMinutes() pulumi.IntOutput

Lifetime of access token. Can be set to a value between 5 and 1440.

func (*ServerPolicyClaim) AuthServerId

func (r *ServerPolicyClaim) AuthServerId() pulumi.StringOutput

Auth Server ID.

func (*ServerPolicyClaim) GrantTypeWhitelists

func (r *ServerPolicyClaim) GrantTypeWhitelists() pulumi.ArrayOutput

Accepted grant type values, `"authorizationCode"`, `"implicit"`, `"password"`

func (*ServerPolicyClaim) GroupBlacklists

func (r *ServerPolicyClaim) GroupBlacklists() pulumi.ArrayOutput

func (*ServerPolicyClaim) GroupWhitelists

func (r *ServerPolicyClaim) GroupWhitelists() pulumi.ArrayOutput

func (*ServerPolicyClaim) ID

ID is this resource's unique identifier assigned by its provider.

func (*ServerPolicyClaim) InlineHookId

func (r *ServerPolicyClaim) InlineHookId() pulumi.StringOutput

The ID of the inline token to trigger.

func (*ServerPolicyClaim) Name

Auth Server Policy Rule name.

func (*ServerPolicyClaim) PolicyId

func (r *ServerPolicyClaim) PolicyId() pulumi.StringOutput

Auth Server Policy ID.

func (*ServerPolicyClaim) Priority

func (r *ServerPolicyClaim) Priority() pulumi.IntOutput

Priority of the auth server policy rule.

func (*ServerPolicyClaim) RefreshTokenLifetimeMinutes

func (r *ServerPolicyClaim) RefreshTokenLifetimeMinutes() pulumi.IntOutput

Lifetime of refresh token.

func (*ServerPolicyClaim) RefreshTokenWindowMinutes

func (r *ServerPolicyClaim) RefreshTokenWindowMinutes() pulumi.IntOutput

func (*ServerPolicyClaim) ScopeWhitelists

func (r *ServerPolicyClaim) ScopeWhitelists() pulumi.ArrayOutput

Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `"*"`.

func (*ServerPolicyClaim) Status

The status of the Auth Server Policy Rule.

func (*ServerPolicyClaim) Type

The type of the Auth Server Policy Rule.

func (*ServerPolicyClaim) URN

URN is this resource's unique name assigned by Pulumi.

func (*ServerPolicyClaim) UserBlacklists

func (r *ServerPolicyClaim) UserBlacklists() pulumi.ArrayOutput

func (*ServerPolicyClaim) UserWhitelists

func (r *ServerPolicyClaim) UserWhitelists() pulumi.ArrayOutput

type ServerPolicyClaimArgs

type ServerPolicyClaimArgs struct {
	// Lifetime of access token. Can be set to a value between 5 and 1440.
	AccessTokenLifetimeMinutes interface{}
	// Auth Server ID.
	AuthServerId interface{}
	// Accepted grant type values, `"authorizationCode"`, `"implicit"`, `"password"`
	GrantTypeWhitelists interface{}
	GroupBlacklists     interface{}
	GroupWhitelists     interface{}
	// The ID of the inline token to trigger.
	InlineHookId interface{}
	// Auth Server Policy Rule name.
	Name interface{}
	// Auth Server Policy ID.
	PolicyId interface{}
	// Priority of the auth server policy rule.
	Priority interface{}
	// Lifetime of refresh token.
	RefreshTokenLifetimeMinutes interface{}
	RefreshTokenWindowMinutes   interface{}
	// Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `"*"`.
	ScopeWhitelists interface{}
	// The status of the Auth Server Policy Rule.
	Status interface{}
	// The type of the Auth Server Policy Rule.
	Type           interface{}
	UserBlacklists interface{}
	UserWhitelists interface{}
}

The set of arguments for constructing a ServerPolicyClaim resource.

type ServerPolicyClaimState

type ServerPolicyClaimState struct {
	// Lifetime of access token. Can be set to a value between 5 and 1440.
	AccessTokenLifetimeMinutes interface{}
	// Auth Server ID.
	AuthServerId interface{}
	// Accepted grant type values, `"authorizationCode"`, `"implicit"`, `"password"`
	GrantTypeWhitelists interface{}
	GroupBlacklists     interface{}
	GroupWhitelists     interface{}
	// The ID of the inline token to trigger.
	InlineHookId interface{}
	// Auth Server Policy Rule name.
	Name interface{}
	// Auth Server Policy ID.
	PolicyId interface{}
	// Priority of the auth server policy rule.
	Priority interface{}
	// Lifetime of refresh token.
	RefreshTokenLifetimeMinutes interface{}
	RefreshTokenWindowMinutes   interface{}
	// Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `"*"`.
	ScopeWhitelists interface{}
	// The status of the Auth Server Policy Rule.
	Status interface{}
	// The type of the Auth Server Policy Rule.
	Type           interface{}
	UserBlacklists interface{}
	UserWhitelists interface{}
}

Input properties used for looking up and filtering ServerPolicyClaim resources.

type ServerPolicyState

type ServerPolicyState struct {
	// The ID of the Auth Server.
	AuthServerId interface{}
	// The clients to whitelist the policy for. `["ALL_CLIENTS"]` is a special value that can be used to whitelist for all clients. Otherwise it is a list of client ids.
	ClientWhitelists interface{}
	// The description of the Auth Server Policy.
	Description interface{}
	// The name of the Auth Server Policy.
	Name interface{}
	// The priority of the Auth Server Policy.
	Priority interface{}
	// The status of the Auth Server Policy.
	Status interface{}
	// The type of the Auth Server Policy.
	Type interface{}
}

Input properties used for looking up and filtering ServerPolicy resources.

type ServerScope

type ServerScope struct {
	// contains filtered or unexported fields
}

Creates an Authorization Server Scope.

This resource allows you to create and configure an Authorization Server Scope.

> This content is derived from https://github.com/articulate/terraform-provider-okta/blob/master/website/docs/r/auth_server_scope.html.markdown.

func GetServerScope

func GetServerScope(ctx *pulumi.Context,
	name string, id pulumi.ID, state *ServerScopeState, opts ...pulumi.ResourceOpt) (*ServerScope, error)

GetServerScope gets an existing ServerScope resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewServerScope

func NewServerScope(ctx *pulumi.Context,
	name string, args *ServerScopeArgs, opts ...pulumi.ResourceOpt) (*ServerScope, error)

NewServerScope registers a new resource with the given unique name, arguments, and options.

func (*ServerScope) AuthServerId

func (r *ServerScope) AuthServerId() pulumi.StringOutput

Auth Server ID.

func (*ServerScope) Consent

func (r *ServerScope) Consent() pulumi.StringOutput

Indicates whether a consent dialog is needed for the scope. It can be set to `"REQUIRED"` or `"IMPLICIT"`.

func (*ServerScope) Default

func (r *ServerScope) Default() pulumi.BoolOutput

A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.

func (*ServerScope) Description

func (r *ServerScope) Description() pulumi.StringOutput

Description of the Auth Server Scope.

func (*ServerScope) ID

func (r *ServerScope) ID() pulumi.IDOutput

ID is this resource's unique identifier assigned by its provider.

func (*ServerScope) MetadataPublish

func (r *ServerScope) MetadataPublish() pulumi.StringOutput

Whether to publish metadata or not. It can be set to `"ALL_CLIENTS"` or `"NO_CLIENTS"`.

func (*ServerScope) Name

func (r *ServerScope) Name() pulumi.StringOutput

Auth Server scope name.

func (*ServerScope) URN

func (r *ServerScope) URN() pulumi.URNOutput

URN is this resource's unique name assigned by Pulumi.

type ServerScopeArgs

type ServerScopeArgs struct {
	// Auth Server ID.
	AuthServerId interface{}
	// Indicates whether a consent dialog is needed for the scope. It can be set to `"REQUIRED"` or `"IMPLICIT"`.
	Consent interface{}
	// A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
	Default interface{}
	// Description of the Auth Server Scope.
	Description interface{}
	// Whether to publish metadata or not. It can be set to `"ALL_CLIENTS"` or `"NO_CLIENTS"`.
	MetadataPublish interface{}
	// Auth Server scope name.
	Name interface{}
}

The set of arguments for constructing a ServerScope resource.

type ServerScopeState

type ServerScopeState struct {
	// Auth Server ID.
	AuthServerId interface{}
	// Indicates whether a consent dialog is needed for the scope. It can be set to `"REQUIRED"` or `"IMPLICIT"`.
	Consent interface{}
	// A default scope will be returned in an access token when the client omits the scope parameter in a token request, provided this scope is allowed as part of the access policy rule.
	Default interface{}
	// Description of the Auth Server Scope.
	Description interface{}
	// Whether to publish metadata or not. It can be set to `"ALL_CLIENTS"` or `"NO_CLIENTS"`.
	MetadataPublish interface{}
	// Auth Server scope name.
	Name interface{}
}

Input properties used for looking up and filtering ServerScope resources.

type ServerState

type ServerState struct {
	// The recipients that the tokens are intended for. This becomes the `aud` claim in an access token.
	Audiences interface{}
	// The timestamp when the authorization server started to use the `kid` for signing tokens.
	CredentialsLastRotated interface{}
	// The timestamp when the authorization server changes the key for signing tokens. Only returned when `credentialsRotationMode` is `"AUTO"`.
	CredentialsNextRotation interface{}
	// The key rotation mode for the authorization server. Can be `"AUTO"` or `"MANUAL"`.
	CredentialsRotationMode interface{}
	// The description of the authorization server.
	Description interface{}
	// The complete URL for a Custom Authorization Server. This becomes the `iss` claim in an access token.
	Issuer interface{}
	// Allows you to use a custom issuer URL. It can be set to `"CUSTOM_URL"` or `"ORG_URL"`
	IssuerMode interface{}
	// The ID of the JSON Web Key used for signing tokens issued by the authorization server.
	Kid interface{}
	// The name of the authorization server.
	Name interface{}
	// The status of the auth server. It defaults to `"ACTIVE"`
	Status interface{}
}

Input properties used for looking up and filtering Server resources.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL