Documentation
¶
Index ¶
- type GetServerScopesArgs
- type GetServerScopesOutputArgs
- type GetServerScopesResult
- type GetServerScopesResultOutput
- func (o GetServerScopesResultOutput) AuthServerId() pulumi.StringOutput
- func (GetServerScopesResultOutput) ElementType() reflect.Type
- func (o GetServerScopesResultOutput) Id() pulumi.StringOutput
- func (o GetServerScopesResultOutput) Scopes() GetServerScopesScopeArrayOutput
- func (o GetServerScopesResultOutput) ToGetServerScopesResultOutput() GetServerScopesResultOutput
- func (o GetServerScopesResultOutput) ToGetServerScopesResultOutputWithContext(ctx context.Context) GetServerScopesResultOutput
- type GetServerScopesScope
- type GetServerScopesScopeArgs
- type GetServerScopesScopeArray
- type GetServerScopesScopeArrayInput
- type GetServerScopesScopeArrayOutput
- func (GetServerScopesScopeArrayOutput) ElementType() reflect.Type
- func (o GetServerScopesScopeArrayOutput) Index(i pulumi.IntInput) GetServerScopesScopeOutput
- func (o GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutput() GetServerScopesScopeArrayOutput
- func (o GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutputWithContext(ctx context.Context) GetServerScopesScopeArrayOutput
- type GetServerScopesScopeInput
- type GetServerScopesScopeOutput
- func (o GetServerScopesScopeOutput) Consent() pulumi.StringOutput
- func (o GetServerScopesScopeOutput) Default() pulumi.BoolOutput
- func (o GetServerScopesScopeOutput) Description() pulumi.StringOutput
- func (o GetServerScopesScopeOutput) DisplayName() pulumi.StringOutput
- func (GetServerScopesScopeOutput) ElementType() reflect.Type
- func (o GetServerScopesScopeOutput) Id() pulumi.StringOutput
- func (o GetServerScopesScopeOutput) MetadataPublish() pulumi.StringOutput
- func (o GetServerScopesScopeOutput) Name() pulumi.StringOutput
- func (o GetServerScopesScopeOutput) Optional() pulumi.BoolOutput
- func (o GetServerScopesScopeOutput) System() pulumi.BoolOutput
- func (o GetServerScopesScopeOutput) ToGetServerScopesScopeOutput() GetServerScopesScopeOutput
- func (o GetServerScopesScopeOutput) ToGetServerScopesScopeOutputWithContext(ctx context.Context) GetServerScopesScopeOutput
- type LookupServerArgs
- type LookupServerOutputArgs
- type LookupServerPolicyArgs
- type LookupServerPolicyOutputArgs
- type LookupServerPolicyResult
- type LookupServerPolicyResultOutput
- func (o LookupServerPolicyResultOutput) AssignedClients() pulumi.StringArrayOutput
- func (o LookupServerPolicyResultOutput) AuthServerId() pulumi.StringOutput
- func (o LookupServerPolicyResultOutput) Description() pulumi.StringOutput
- func (LookupServerPolicyResultOutput) ElementType() reflect.Type
- func (o LookupServerPolicyResultOutput) Id() pulumi.StringOutput
- func (o LookupServerPolicyResultOutput) Name() pulumi.StringOutput
- func (o LookupServerPolicyResultOutput) Priority() pulumi.IntOutput
- func (o LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutput() LookupServerPolicyResultOutput
- func (o LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutputWithContext(ctx context.Context) LookupServerPolicyResultOutput
- type LookupServerResult
- type LookupServerResultOutput
- func (o LookupServerResultOutput) Audiences() pulumi.StringArrayOutput
- func (o LookupServerResultOutput) CredentialsLastRotated() pulumi.StringOutput
- func (o LookupServerResultOutput) CredentialsNextRotation() pulumi.StringOutput
- func (o LookupServerResultOutput) CredentialsRotationMode() pulumi.StringOutput
- func (o LookupServerResultOutput) Description() pulumi.StringOutput
- func (LookupServerResultOutput) ElementType() reflect.Type
- func (o LookupServerResultOutput) Id() pulumi.StringOutput
- func (o LookupServerResultOutput) Issuer() pulumi.StringOutput
- func (o LookupServerResultOutput) IssuerMode() pulumi.StringOutput
- func (o LookupServerResultOutput) Kid() pulumi.StringOutput
- func (o LookupServerResultOutput) Name() pulumi.StringOutput
- func (o LookupServerResultOutput) Status() pulumi.StringOutput
- func (o LookupServerResultOutput) ToLookupServerResultOutput() LookupServerResultOutput
- func (o LookupServerResultOutput) ToLookupServerResultOutputWithContext(ctx context.Context) LookupServerResultOutput
- type Server
- type ServerArgs
- type ServerArray
- type ServerArrayInput
- type ServerArrayOutput
- type ServerClaim
- type ServerClaimArgs
- type ServerClaimArray
- type ServerClaimArrayInput
- type ServerClaimArrayOutput
- func (ServerClaimArrayOutput) ElementType() reflect.Type
- func (o ServerClaimArrayOutput) Index(i pulumi.IntInput) ServerClaimOutput
- func (o ServerClaimArrayOutput) ToServerClaimArrayOutput() ServerClaimArrayOutput
- func (o ServerClaimArrayOutput) ToServerClaimArrayOutputWithContext(ctx context.Context) ServerClaimArrayOutput
- type ServerClaimInput
- type ServerClaimMap
- type ServerClaimMapInput
- type ServerClaimMapOutput
- func (ServerClaimMapOutput) ElementType() reflect.Type
- func (o ServerClaimMapOutput) MapIndex(k pulumi.StringInput) ServerClaimOutput
- func (o ServerClaimMapOutput) ToServerClaimMapOutput() ServerClaimMapOutput
- func (o ServerClaimMapOutput) ToServerClaimMapOutputWithContext(ctx context.Context) ServerClaimMapOutput
- type ServerClaimOutput
- func (o ServerClaimOutput) AlwaysIncludeInToken() pulumi.BoolPtrOutput
- func (o ServerClaimOutput) AuthServerId() pulumi.StringOutput
- func (o ServerClaimOutput) ClaimType() pulumi.StringOutput
- func (ServerClaimOutput) ElementType() reflect.Type
- func (o ServerClaimOutput) GroupFilterType() pulumi.StringPtrOutput
- func (o ServerClaimOutput) Name() pulumi.StringOutput
- func (o ServerClaimOutput) Scopes() pulumi.StringArrayOutput
- func (o ServerClaimOutput) Status() pulumi.StringPtrOutput
- func (o ServerClaimOutput) ToServerClaimOutput() ServerClaimOutput
- func (o ServerClaimOutput) ToServerClaimOutputWithContext(ctx context.Context) ServerClaimOutput
- func (o ServerClaimOutput) Value() pulumi.StringOutput
- func (o ServerClaimOutput) ValueType() pulumi.StringPtrOutput
- type ServerClaimState
- type ServerInput
- type ServerMap
- type ServerMapInput
- type ServerMapOutput
- type ServerOutput
- func (o ServerOutput) Audiences() pulumi.StringArrayOutput
- func (o ServerOutput) CredentialsLastRotated() pulumi.StringOutput
- func (o ServerOutput) CredentialsNextRotation() pulumi.StringOutput
- func (o ServerOutput) CredentialsRotationMode() pulumi.StringPtrOutput
- func (o ServerOutput) Description() pulumi.StringPtrOutput
- func (ServerOutput) ElementType() reflect.Type
- func (o ServerOutput) Issuer() pulumi.StringOutput
- func (o ServerOutput) IssuerMode() pulumi.StringPtrOutput
- func (o ServerOutput) Kid() pulumi.StringOutput
- func (o ServerOutput) Name() pulumi.StringOutput
- func (o ServerOutput) Status() pulumi.StringPtrOutput
- func (o ServerOutput) ToServerOutput() ServerOutput
- func (o ServerOutput) ToServerOutputWithContext(ctx context.Context) ServerOutput
- type ServerPolicy
- type ServerPolicyArgs
- type ServerPolicyArray
- type ServerPolicyArrayInput
- type ServerPolicyArrayOutput
- func (ServerPolicyArrayOutput) ElementType() reflect.Type
- func (o ServerPolicyArrayOutput) Index(i pulumi.IntInput) ServerPolicyOutput
- func (o ServerPolicyArrayOutput) ToServerPolicyArrayOutput() ServerPolicyArrayOutput
- func (o ServerPolicyArrayOutput) ToServerPolicyArrayOutputWithContext(ctx context.Context) ServerPolicyArrayOutput
- type ServerPolicyClaimdeprecated
- type ServerPolicyClaimArgs
- type ServerPolicyClaimArray
- type ServerPolicyClaimArrayInput
- type ServerPolicyClaimArrayOutput
- func (ServerPolicyClaimArrayOutput) ElementType() reflect.Type
- func (o ServerPolicyClaimArrayOutput) Index(i pulumi.IntInput) ServerPolicyClaimOutput
- func (o ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutput() ServerPolicyClaimArrayOutput
- func (o ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutputWithContext(ctx context.Context) ServerPolicyClaimArrayOutput
- type ServerPolicyClaimInput
- type ServerPolicyClaimMap
- type ServerPolicyClaimMapInput
- type ServerPolicyClaimMapOutput
- func (ServerPolicyClaimMapOutput) ElementType() reflect.Type
- func (o ServerPolicyClaimMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyClaimOutput
- func (o ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutput() ServerPolicyClaimMapOutput
- func (o ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutputWithContext(ctx context.Context) ServerPolicyClaimMapOutput
- type ServerPolicyClaimOutput
- func (o ServerPolicyClaimOutput) AccessTokenLifetimeMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyClaimOutput) AuthServerId() pulumi.StringOutput
- func (ServerPolicyClaimOutput) ElementType() reflect.Type
- func (o ServerPolicyClaimOutput) GrantTypeWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyClaimOutput) GroupBlacklists() pulumi.StringArrayOutput
- func (o ServerPolicyClaimOutput) GroupWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyClaimOutput) InlineHookId() pulumi.StringPtrOutput
- func (o ServerPolicyClaimOutput) Name() pulumi.StringOutput
- func (o ServerPolicyClaimOutput) PolicyId() pulumi.StringOutput
- func (o ServerPolicyClaimOutput) Priority() pulumi.IntOutput
- func (o ServerPolicyClaimOutput) RefreshTokenLifetimeMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyClaimOutput) RefreshTokenWindowMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyClaimOutput) ScopeWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyClaimOutput) Status() pulumi.StringPtrOutput
- func (o ServerPolicyClaimOutput) System() pulumi.BoolOutput
- func (o ServerPolicyClaimOutput) ToServerPolicyClaimOutput() ServerPolicyClaimOutput
- func (o ServerPolicyClaimOutput) ToServerPolicyClaimOutputWithContext(ctx context.Context) ServerPolicyClaimOutput
- func (o ServerPolicyClaimOutput) Type() pulumi.StringPtrOutput
- func (o ServerPolicyClaimOutput) UserBlacklists() pulumi.StringArrayOutput
- func (o ServerPolicyClaimOutput) UserWhitelists() pulumi.StringArrayOutput
- type ServerPolicyClaimState
- type ServerPolicyInput
- type ServerPolicyMap
- type ServerPolicyMapInput
- type ServerPolicyMapOutput
- func (ServerPolicyMapOutput) ElementType() reflect.Type
- func (o ServerPolicyMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyOutput
- func (o ServerPolicyMapOutput) ToServerPolicyMapOutput() ServerPolicyMapOutput
- func (o ServerPolicyMapOutput) ToServerPolicyMapOutputWithContext(ctx context.Context) ServerPolicyMapOutput
- type ServerPolicyOutput
- func (o ServerPolicyOutput) AuthServerId() pulumi.StringOutput
- func (o ServerPolicyOutput) ClientWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyOutput) Description() pulumi.StringOutput
- func (ServerPolicyOutput) ElementType() reflect.Type
- func (o ServerPolicyOutput) Name() pulumi.StringOutput
- func (o ServerPolicyOutput) Priority() pulumi.IntOutput
- func (o ServerPolicyOutput) Status() pulumi.StringPtrOutput
- func (o ServerPolicyOutput) ToServerPolicyOutput() ServerPolicyOutput
- func (o ServerPolicyOutput) ToServerPolicyOutputWithContext(ctx context.Context) ServerPolicyOutput
- type ServerPolicyRule
- type ServerPolicyRuleArgs
- type ServerPolicyRuleArray
- type ServerPolicyRuleArrayInput
- type ServerPolicyRuleArrayOutput
- func (ServerPolicyRuleArrayOutput) ElementType() reflect.Type
- func (o ServerPolicyRuleArrayOutput) Index(i pulumi.IntInput) ServerPolicyRuleOutput
- func (o ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutput() ServerPolicyRuleArrayOutput
- func (o ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutputWithContext(ctx context.Context) ServerPolicyRuleArrayOutput
- type ServerPolicyRuleInput
- type ServerPolicyRuleMap
- type ServerPolicyRuleMapInput
- type ServerPolicyRuleMapOutput
- func (ServerPolicyRuleMapOutput) ElementType() reflect.Type
- func (o ServerPolicyRuleMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyRuleOutput
- func (o ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutput() ServerPolicyRuleMapOutput
- func (o ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutputWithContext(ctx context.Context) ServerPolicyRuleMapOutput
- type ServerPolicyRuleOutput
- func (o ServerPolicyRuleOutput) AccessTokenLifetimeMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyRuleOutput) AuthServerId() pulumi.StringOutput
- func (ServerPolicyRuleOutput) ElementType() reflect.Type
- func (o ServerPolicyRuleOutput) GrantTypeWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyRuleOutput) GroupBlacklists() pulumi.StringArrayOutput
- func (o ServerPolicyRuleOutput) GroupWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyRuleOutput) InlineHookId() pulumi.StringPtrOutput
- func (o ServerPolicyRuleOutput) Name() pulumi.StringOutput
- func (o ServerPolicyRuleOutput) PolicyId() pulumi.StringOutput
- func (o ServerPolicyRuleOutput) Priority() pulumi.IntOutput
- func (o ServerPolicyRuleOutput) RefreshTokenLifetimeMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyRuleOutput) RefreshTokenWindowMinutes() pulumi.IntPtrOutput
- func (o ServerPolicyRuleOutput) ScopeWhitelists() pulumi.StringArrayOutput
- func (o ServerPolicyRuleOutput) Status() pulumi.StringPtrOutput
- func (o ServerPolicyRuleOutput) System() pulumi.BoolOutput
- func (o ServerPolicyRuleOutput) ToServerPolicyRuleOutput() ServerPolicyRuleOutput
- func (o ServerPolicyRuleOutput) ToServerPolicyRuleOutputWithContext(ctx context.Context) ServerPolicyRuleOutput
- func (o ServerPolicyRuleOutput) Type() pulumi.StringPtrOutput
- func (o ServerPolicyRuleOutput) UserBlacklists() pulumi.StringArrayOutput
- func (o ServerPolicyRuleOutput) UserWhitelists() pulumi.StringArrayOutput
- type ServerPolicyRuleState
- type ServerPolicyState
- type ServerScope
- type ServerScopeArgs
- type ServerScopeArray
- type ServerScopeArrayInput
- type ServerScopeArrayOutput
- func (ServerScopeArrayOutput) ElementType() reflect.Type
- func (o ServerScopeArrayOutput) Index(i pulumi.IntInput) ServerScopeOutput
- func (o ServerScopeArrayOutput) ToServerScopeArrayOutput() ServerScopeArrayOutput
- func (o ServerScopeArrayOutput) ToServerScopeArrayOutputWithContext(ctx context.Context) ServerScopeArrayOutput
- type ServerScopeInput
- type ServerScopeMap
- type ServerScopeMapInput
- type ServerScopeMapOutput
- func (ServerScopeMapOutput) ElementType() reflect.Type
- func (o ServerScopeMapOutput) MapIndex(k pulumi.StringInput) ServerScopeOutput
- func (o ServerScopeMapOutput) ToServerScopeMapOutput() ServerScopeMapOutput
- func (o ServerScopeMapOutput) ToServerScopeMapOutputWithContext(ctx context.Context) ServerScopeMapOutput
- type ServerScopeOutput
- func (o ServerScopeOutput) AuthServerId() pulumi.StringOutput
- func (o ServerScopeOutput) Consent() pulumi.StringPtrOutput
- func (o ServerScopeOutput) Default() pulumi.BoolPtrOutput
- func (o ServerScopeOutput) Description() pulumi.StringPtrOutput
- func (o ServerScopeOutput) DisplayName() pulumi.StringPtrOutput
- func (ServerScopeOutput) ElementType() reflect.Type
- func (o ServerScopeOutput) MetadataPublish() pulumi.StringPtrOutput
- func (o ServerScopeOutput) Name() pulumi.StringOutput
- func (o ServerScopeOutput) Optional() pulumi.BoolPtrOutput
- func (o ServerScopeOutput) System() pulumi.BoolOutput
- func (o ServerScopeOutput) ToServerScopeOutput() ServerScopeOutput
- func (o ServerScopeOutput) ToServerScopeOutputWithContext(ctx context.Context) ServerScopeOutput
- type ServerScopeState
- type ServerState
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetServerScopesArgs ¶
type GetServerScopesArgs struct { // Auth server ID AuthServerId string `pulumi:"authServerId"` }
A collection of arguments for invoking getServerScopes.
type GetServerScopesOutputArgs ¶
type GetServerScopesOutputArgs struct { // Auth server ID AuthServerId pulumi.StringInput `pulumi:"authServerId"` }
A collection of arguments for invoking getServerScopes.
func (GetServerScopesOutputArgs) ElementType ¶
func (GetServerScopesOutputArgs) ElementType() reflect.Type
type GetServerScopesResult ¶
type GetServerScopesResult struct { // Auth server ID AuthServerId string `pulumi:"authServerId"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // Collection of authorization server scopes retrieved from Okta with the following properties. Scopes []GetServerScopesScope `pulumi:"scopes"` }
A collection of values returned by getServerScopes.
func GetServerScopes ¶
func GetServerScopes(ctx *pulumi.Context, args *GetServerScopesArgs, opts ...pulumi.InvokeOption) (*GetServerScopesResult, error)
Get a list of authorization server scopes from Okta.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.GetServerScopes(ctx, &auth.GetServerScopesArgs{ AuthServerId: "default", }, nil) if err != nil { return err } return nil }) }
```
type GetServerScopesResultOutput ¶
type GetServerScopesResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getServerScopes.
func GetServerScopesOutput ¶
func GetServerScopesOutput(ctx *pulumi.Context, args GetServerScopesOutputArgs, opts ...pulumi.InvokeOption) GetServerScopesResultOutput
func (GetServerScopesResultOutput) AuthServerId ¶
func (o GetServerScopesResultOutput) AuthServerId() pulumi.StringOutput
Auth server ID
func (GetServerScopesResultOutput) ElementType ¶
func (GetServerScopesResultOutput) ElementType() reflect.Type
func (GetServerScopesResultOutput) Id ¶
func (o GetServerScopesResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (GetServerScopesResultOutput) Scopes ¶
func (o GetServerScopesResultOutput) Scopes() GetServerScopesScopeArrayOutput
Collection of authorization server scopes retrieved from Okta with the following properties.
func (GetServerScopesResultOutput) ToGetServerScopesResultOutput ¶
func (o GetServerScopesResultOutput) ToGetServerScopesResultOutput() GetServerScopesResultOutput
func (GetServerScopesResultOutput) ToGetServerScopesResultOutputWithContext ¶
func (o GetServerScopesResultOutput) ToGetServerScopesResultOutputWithContext(ctx context.Context) GetServerScopesResultOutput
type GetServerScopesScope ¶
type GetServerScopesScope struct { // Indicates whether a consent dialog is needed for the Scope Consent string `pulumi:"consent"` // Whether the Scope is a default Scope Default bool `pulumi:"default"` // Description of the Scope Description string `pulumi:"description"` // Name of the end user displayed in a consent dialog box DisplayName string `pulumi:"displayName"` // ID of the Scope Id string `pulumi:"id"` // Whether the Scope should be included in the metadata MetadataPublish string `pulumi:"metadataPublish"` // Name of the Scope Name string `pulumi:"name"` // Whether the Scope is optional Optional bool `pulumi:"optional"` // Whether Okta created the Scope System bool `pulumi:"system"` }
type GetServerScopesScopeArgs ¶
type GetServerScopesScopeArgs struct { // Indicates whether a consent dialog is needed for the Scope Consent pulumi.StringInput `pulumi:"consent"` // Whether the Scope is a default Scope Default pulumi.BoolInput `pulumi:"default"` // Description of the Scope Description pulumi.StringInput `pulumi:"description"` // Name of the end user displayed in a consent dialog box DisplayName pulumi.StringInput `pulumi:"displayName"` // ID of the Scope Id pulumi.StringInput `pulumi:"id"` // Whether the Scope should be included in the metadata MetadataPublish pulumi.StringInput `pulumi:"metadataPublish"` // Name of the Scope Name pulumi.StringInput `pulumi:"name"` // Whether the Scope is optional Optional pulumi.BoolInput `pulumi:"optional"` // Whether Okta created the Scope System pulumi.BoolInput `pulumi:"system"` }
func (GetServerScopesScopeArgs) ElementType ¶
func (GetServerScopesScopeArgs) ElementType() reflect.Type
func (GetServerScopesScopeArgs) ToGetServerScopesScopeOutput ¶
func (i GetServerScopesScopeArgs) ToGetServerScopesScopeOutput() GetServerScopesScopeOutput
func (GetServerScopesScopeArgs) ToGetServerScopesScopeOutputWithContext ¶
func (i GetServerScopesScopeArgs) ToGetServerScopesScopeOutputWithContext(ctx context.Context) GetServerScopesScopeOutput
type GetServerScopesScopeArray ¶
type GetServerScopesScopeArray []GetServerScopesScopeInput
func (GetServerScopesScopeArray) ElementType ¶
func (GetServerScopesScopeArray) ElementType() reflect.Type
func (GetServerScopesScopeArray) ToGetServerScopesScopeArrayOutput ¶
func (i GetServerScopesScopeArray) ToGetServerScopesScopeArrayOutput() GetServerScopesScopeArrayOutput
func (GetServerScopesScopeArray) ToGetServerScopesScopeArrayOutputWithContext ¶
func (i GetServerScopesScopeArray) ToGetServerScopesScopeArrayOutputWithContext(ctx context.Context) GetServerScopesScopeArrayOutput
type GetServerScopesScopeArrayInput ¶
type GetServerScopesScopeArrayInput interface { pulumi.Input ToGetServerScopesScopeArrayOutput() GetServerScopesScopeArrayOutput ToGetServerScopesScopeArrayOutputWithContext(context.Context) GetServerScopesScopeArrayOutput }
GetServerScopesScopeArrayInput is an input type that accepts GetServerScopesScopeArray and GetServerScopesScopeArrayOutput values. You can construct a concrete instance of `GetServerScopesScopeArrayInput` via:
GetServerScopesScopeArray{ GetServerScopesScopeArgs{...} }
type GetServerScopesScopeArrayOutput ¶
type GetServerScopesScopeArrayOutput struct{ *pulumi.OutputState }
func (GetServerScopesScopeArrayOutput) ElementType ¶
func (GetServerScopesScopeArrayOutput) ElementType() reflect.Type
func (GetServerScopesScopeArrayOutput) Index ¶
func (o GetServerScopesScopeArrayOutput) Index(i pulumi.IntInput) GetServerScopesScopeOutput
func (GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutput ¶
func (o GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutput() GetServerScopesScopeArrayOutput
func (GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutputWithContext ¶
func (o GetServerScopesScopeArrayOutput) ToGetServerScopesScopeArrayOutputWithContext(ctx context.Context) GetServerScopesScopeArrayOutput
type GetServerScopesScopeInput ¶
type GetServerScopesScopeInput interface { pulumi.Input ToGetServerScopesScopeOutput() GetServerScopesScopeOutput ToGetServerScopesScopeOutputWithContext(context.Context) GetServerScopesScopeOutput }
GetServerScopesScopeInput is an input type that accepts GetServerScopesScopeArgs and GetServerScopesScopeOutput values. You can construct a concrete instance of `GetServerScopesScopeInput` via:
GetServerScopesScopeArgs{...}
type GetServerScopesScopeOutput ¶
type GetServerScopesScopeOutput struct{ *pulumi.OutputState }
func (GetServerScopesScopeOutput) Consent ¶
func (o GetServerScopesScopeOutput) Consent() pulumi.StringOutput
Indicates whether a consent dialog is needed for the Scope
func (GetServerScopesScopeOutput) Default ¶
func (o GetServerScopesScopeOutput) Default() pulumi.BoolOutput
Whether the Scope is a default Scope
func (GetServerScopesScopeOutput) Description ¶
func (o GetServerScopesScopeOutput) Description() pulumi.StringOutput
Description of the Scope
func (GetServerScopesScopeOutput) DisplayName ¶
func (o GetServerScopesScopeOutput) DisplayName() pulumi.StringOutput
Name of the end user displayed in a consent dialog box
func (GetServerScopesScopeOutput) ElementType ¶
func (GetServerScopesScopeOutput) ElementType() reflect.Type
func (GetServerScopesScopeOutput) Id ¶
func (o GetServerScopesScopeOutput) Id() pulumi.StringOutput
ID of the Scope
func (GetServerScopesScopeOutput) MetadataPublish ¶
func (o GetServerScopesScopeOutput) MetadataPublish() pulumi.StringOutput
Whether the Scope should be included in the metadata
func (GetServerScopesScopeOutput) Name ¶
func (o GetServerScopesScopeOutput) Name() pulumi.StringOutput
Name of the Scope
func (GetServerScopesScopeOutput) Optional ¶ added in v4.4.0
func (o GetServerScopesScopeOutput) Optional() pulumi.BoolOutput
Whether the Scope is optional
func (GetServerScopesScopeOutput) System ¶
func (o GetServerScopesScopeOutput) System() pulumi.BoolOutput
Whether Okta created the Scope
func (GetServerScopesScopeOutput) ToGetServerScopesScopeOutput ¶
func (o GetServerScopesScopeOutput) ToGetServerScopesScopeOutput() GetServerScopesScopeOutput
func (GetServerScopesScopeOutput) ToGetServerScopesScopeOutputWithContext ¶
func (o GetServerScopesScopeOutput) ToGetServerScopesScopeOutputWithContext(ctx context.Context) GetServerScopesScopeOutput
type LookupServerArgs ¶
type LookupServerArgs struct { // The name of the auth server to retrieve. Name string `pulumi:"name"` }
A collection of arguments for invoking getServer.
type LookupServerOutputArgs ¶
type LookupServerOutputArgs struct { // The name of the auth server to retrieve. Name pulumi.StringInput `pulumi:"name"` }
A collection of arguments for invoking getServer.
func (LookupServerOutputArgs) ElementType ¶
func (LookupServerOutputArgs) ElementType() reflect.Type
type LookupServerPolicyArgs ¶
type LookupServerPolicyArgs struct { // Auth server ID AuthServerId string `pulumi:"authServerId"` // Name of the policy Name string `pulumi:"name"` }
A collection of arguments for invoking getServerPolicy.
type LookupServerPolicyOutputArgs ¶
type LookupServerPolicyOutputArgs struct { // Auth server ID AuthServerId pulumi.StringInput `pulumi:"authServerId"` // Name of the policy Name pulumi.StringInput `pulumi:"name"` }
A collection of arguments for invoking getServerPolicy.
func (LookupServerPolicyOutputArgs) ElementType ¶
func (LookupServerPolicyOutputArgs) ElementType() reflect.Type
type LookupServerPolicyResult ¶
type LookupServerPolicyResult struct { // List of clients this policy is assigned to. `[ALL_CLIENTS]` is a special value when policy is assigned to all clients. AssignedClients []string `pulumi:"assignedClients"` // Auth server ID AuthServerId string `pulumi:"authServerId"` // Description of authorization server policy. Description string `pulumi:"description"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // Name of the policy Name string `pulumi:"name"` // Priority of the auth server policy Priority int `pulumi:"priority"` }
A collection of values returned by getServerPolicy.
func LookupServerPolicy ¶
func LookupServerPolicy(ctx *pulumi.Context, args *LookupServerPolicyArgs, opts ...pulumi.InvokeOption) (*LookupServerPolicyResult, error)
Get an authorization server policy from Okta.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.LookupServerPolicy(ctx, &auth.LookupServerPolicyArgs{ AuthServerId: "<auth server id>", Name: "staff", }, nil) if err != nil { return err } return nil }) }
```
type LookupServerPolicyResultOutput ¶
type LookupServerPolicyResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getServerPolicy.
func LookupServerPolicyOutput ¶
func LookupServerPolicyOutput(ctx *pulumi.Context, args LookupServerPolicyOutputArgs, opts ...pulumi.InvokeOption) LookupServerPolicyResultOutput
func (LookupServerPolicyResultOutput) AssignedClients ¶
func (o LookupServerPolicyResultOutput) AssignedClients() pulumi.StringArrayOutput
List of clients this policy is assigned to. `[ALL_CLIENTS]` is a special value when policy is assigned to all clients.
func (LookupServerPolicyResultOutput) AuthServerId ¶
func (o LookupServerPolicyResultOutput) AuthServerId() pulumi.StringOutput
Auth server ID
func (LookupServerPolicyResultOutput) Description ¶
func (o LookupServerPolicyResultOutput) Description() pulumi.StringOutput
Description of authorization server policy.
func (LookupServerPolicyResultOutput) ElementType ¶
func (LookupServerPolicyResultOutput) ElementType() reflect.Type
func (LookupServerPolicyResultOutput) Id ¶
func (o LookupServerPolicyResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupServerPolicyResultOutput) Name ¶
func (o LookupServerPolicyResultOutput) Name() pulumi.StringOutput
Name of the policy
func (LookupServerPolicyResultOutput) Priority ¶
func (o LookupServerPolicyResultOutput) Priority() pulumi.IntOutput
Priority of the auth server policy
func (LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutput ¶
func (o LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutput() LookupServerPolicyResultOutput
func (LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutputWithContext ¶
func (o LookupServerPolicyResultOutput) ToLookupServerPolicyResultOutputWithContext(ctx context.Context) LookupServerPolicyResultOutput
type LookupServerResult ¶
type LookupServerResult struct { // Description of Authorization server. Audiences []string `pulumi:"audiences"` // Last time credentials were rotated. CredentialsLastRotated string `pulumi:"credentialsLastRotated"` // Next time credentials will be rotated CredentialsNextRotation string `pulumi:"credentialsNextRotation"` // Mode of credential rotation, auto or manual. CredentialsRotationMode string `pulumi:"credentialsRotationMode"` // Description of Authorization server. Description string `pulumi:"description"` // The provider-assigned unique ID for this managed resource. Id string `pulumi:"id"` // The complete URL of the authorization server. This becomes the `iss` claim in an access token. Issuer string `pulumi:"issuer"` // Can be set to `CUSTOM_URL` or `ORG_URL` IssuerMode string `pulumi:"issuerMode"` // Auth server key id. Kid string `pulumi:"kid"` // The name of the auth server to retrieve. Name string `pulumi:"name"` // The activation status of the authorization server. Status string `pulumi:"status"` }
A collection of values returned by getServer.
func LookupServer ¶
func LookupServer(ctx *pulumi.Context, args *LookupServerArgs, opts ...pulumi.InvokeOption) (*LookupServerResult, error)
Get an auth server from Okta.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.LookupServer(ctx, &auth.LookupServerArgs{ Name: "Example Auth", }, nil) if err != nil { return err } return nil }) }
```
type LookupServerResultOutput ¶
type LookupServerResultOutput struct{ *pulumi.OutputState }
A collection of values returned by getServer.
func LookupServerOutput ¶
func LookupServerOutput(ctx *pulumi.Context, args LookupServerOutputArgs, opts ...pulumi.InvokeOption) LookupServerResultOutput
func (LookupServerResultOutput) Audiences ¶
func (o LookupServerResultOutput) Audiences() pulumi.StringArrayOutput
Description of Authorization server.
func (LookupServerResultOutput) CredentialsLastRotated ¶
func (o LookupServerResultOutput) CredentialsLastRotated() pulumi.StringOutput
Last time credentials were rotated.
func (LookupServerResultOutput) CredentialsNextRotation ¶
func (o LookupServerResultOutput) CredentialsNextRotation() pulumi.StringOutput
Next time credentials will be rotated
func (LookupServerResultOutput) CredentialsRotationMode ¶
func (o LookupServerResultOutput) CredentialsRotationMode() pulumi.StringOutput
Mode of credential rotation, auto or manual.
func (LookupServerResultOutput) Description ¶
func (o LookupServerResultOutput) Description() pulumi.StringOutput
Description of Authorization server.
func (LookupServerResultOutput) ElementType ¶
func (LookupServerResultOutput) ElementType() reflect.Type
func (LookupServerResultOutput) Id ¶
func (o LookupServerResultOutput) Id() pulumi.StringOutput
The provider-assigned unique ID for this managed resource.
func (LookupServerResultOutput) Issuer ¶
func (o LookupServerResultOutput) Issuer() pulumi.StringOutput
The complete URL of the authorization server. This becomes the `iss` claim in an access token.
func (LookupServerResultOutput) IssuerMode ¶
func (o LookupServerResultOutput) IssuerMode() pulumi.StringOutput
Can be set to `CUSTOM_URL` or `ORG_URL`
func (LookupServerResultOutput) Kid ¶
func (o LookupServerResultOutput) Kid() pulumi.StringOutput
Auth server key id.
func (LookupServerResultOutput) Name ¶
func (o LookupServerResultOutput) Name() pulumi.StringOutput
The name of the auth server to retrieve.
func (LookupServerResultOutput) Status ¶
func (o LookupServerResultOutput) Status() pulumi.StringOutput
The activation status of the authorization server.
func (LookupServerResultOutput) ToLookupServerResultOutput ¶
func (o LookupServerResultOutput) ToLookupServerResultOutput() LookupServerResultOutput
func (LookupServerResultOutput) ToLookupServerResultOutputWithContext ¶
func (o LookupServerResultOutput) ToLookupServerResultOutputWithContext(ctx context.Context) LookupServerResultOutput
type Server ¶
type Server struct { pulumi.CustomResourceState // The recipients that the tokens are intended for. This becomes the `aud` claim in an access token. Currently Okta only supports a single value here. Audiences pulumi.StringArrayOutput `pulumi:"audiences"` // The timestamp when the authorization server started to use the `kid` for signing tokens. CredentialsLastRotated pulumi.StringOutput `pulumi:"credentialsLastRotated"` // The timestamp when the authorization server changes the key for signing tokens. Only returned when `credentialsRotationMode` is `AUTO`. CredentialsNextRotation pulumi.StringOutput `pulumi:"credentialsNextRotation"` // The key rotation mode for the authorization server. Can be `AUTO` or `MANUAL`. Default: `AUTO` CredentialsRotationMode pulumi.StringPtrOutput `pulumi:"credentialsRotationMode"` // The description of the authorization server. Description pulumi.StringPtrOutput `pulumi:"description"` // The complete URL for a Custom Authorization Server. This becomes the `iss` claim in an access token. Issuer pulumi.StringOutput `pulumi:"issuer"` // *Early Access Property*. Allows you to use a custom issuer URL. It can be set to `CUSTOM_URL`, `ORG_URL`, or `DYNAMIC`. Default: `ORG_URL` IssuerMode pulumi.StringPtrOutput `pulumi:"issuerMode"` // The ID of the JSON Web Key used for signing tokens issued by the authorization server. Kid pulumi.StringOutput `pulumi:"kid"` // The name of the authorization server. Name pulumi.StringOutput `pulumi:"name"` // Default to `ACTIVE` Status pulumi.StringPtrOutput `pulumi:"status"` }
Creates an Authorization Server. This resource allows you to create and configure an Authorization Server.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServer(ctx, "example", &auth.ServerArgs{ Audiences: pulumi.StringArray{ pulumi.String("api://example"), }, Description: pulumi.String("My Example Auth Server"), Name: pulumi.String("example"), IssuerMode: pulumi.String("CUSTOM_URL"), Status: pulumi.String("ACTIVE"), }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/server:Server example <auth_server_id> ```
func GetServer ¶
func GetServer(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*Server, error)
NewServer registers a new resource with the given unique name, arguments, and options.
func (*Server) ElementType ¶
func (*Server) ToServerOutput ¶
func (i *Server) ToServerOutput() ServerOutput
func (*Server) ToServerOutputWithContext ¶
func (i *Server) ToServerOutputWithContext(ctx context.Context) ServerOutput
type ServerArgs ¶
type ServerArgs struct { // The recipients that the tokens are intended for. This becomes the `aud` claim in an access token. Currently Okta only supports a single value here. Audiences pulumi.StringArrayInput // The key rotation mode for the authorization server. Can be `AUTO` or `MANUAL`. Default: `AUTO` CredentialsRotationMode pulumi.StringPtrInput // The description of the authorization server. Description pulumi.StringPtrInput // *Early Access Property*. Allows you to use a custom issuer URL. It can be set to `CUSTOM_URL`, `ORG_URL`, or `DYNAMIC`. Default: `ORG_URL` IssuerMode pulumi.StringPtrInput // The name of the authorization server. Name pulumi.StringPtrInput // Default to `ACTIVE` Status pulumi.StringPtrInput }
The set of arguments for constructing a Server resource.
func (ServerArgs) ElementType ¶
func (ServerArgs) ElementType() reflect.Type
type ServerArray ¶
type ServerArray []ServerInput
func (ServerArray) ElementType ¶
func (ServerArray) ElementType() reflect.Type
func (ServerArray) ToServerArrayOutput ¶
func (i ServerArray) ToServerArrayOutput() ServerArrayOutput
func (ServerArray) ToServerArrayOutputWithContext ¶
func (i ServerArray) ToServerArrayOutputWithContext(ctx context.Context) ServerArrayOutput
type ServerArrayInput ¶
type ServerArrayInput interface { pulumi.Input ToServerArrayOutput() ServerArrayOutput ToServerArrayOutputWithContext(context.Context) ServerArrayOutput }
ServerArrayInput is an input type that accepts ServerArray and ServerArrayOutput values. You can construct a concrete instance of `ServerArrayInput` via:
ServerArray{ ServerArgs{...} }
type ServerArrayOutput ¶
type ServerArrayOutput struct{ *pulumi.OutputState }
func (ServerArrayOutput) ElementType ¶
func (ServerArrayOutput) ElementType() reflect.Type
func (ServerArrayOutput) Index ¶
func (o ServerArrayOutput) Index(i pulumi.IntInput) ServerOutput
func (ServerArrayOutput) ToServerArrayOutput ¶
func (o ServerArrayOutput) ToServerArrayOutput() ServerArrayOutput
func (ServerArrayOutput) ToServerArrayOutputWithContext ¶
func (o ServerArrayOutput) ToServerArrayOutputWithContext(ctx context.Context) ServerArrayOutput
type ServerClaim ¶
type ServerClaim struct { pulumi.CustomResourceState // Specifies whether to include claims in token, by default it is set to `true`. AlwaysIncludeInToken pulumi.BoolPtrOutput `pulumi:"alwaysIncludeInToken"` // ID of the authorization server. AuthServerId pulumi.StringOutput `pulumi:"authServerId"` // Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`. ClaimType pulumi.StringOutput `pulumi:"claimType"` // Specifies the type of group filter if `valueType` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`. GroupFilterType pulumi.StringPtrOutput `pulumi:"groupFilterType"` // The name of the claim. Name pulumi.StringOutput `pulumi:"name"` // The list of scopes the auth server claim is tied to. Scopes pulumi.StringArrayOutput `pulumi:"scopes"` // Default to `ACTIVE` Status pulumi.StringPtrOutput `pulumi:"status"` // The value of the claim. Value pulumi.StringOutput `pulumi:"value"` // The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`. ValueType pulumi.StringPtrOutput `pulumi:"valueType"` }
Creates an Authorization Server Claim. This resource allows you to create and configure an Authorization Server Claim.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServerClaim(ctx, "example", &auth.ServerClaimArgs{ AuthServerId: pulumi.String("<auth server id>"), Name: pulumi.String("staff"), Value: pulumi.String("String.substringAfter(user.email, \"@\") == \"example.com\""), Scopes: pulumi.StringArray{ exampleOktaAuthServerScope.Name, }, ClaimType: pulumi.String("IDENTITY"), }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/serverClaim:ServerClaim example <auth_server_id>/<claim_id> ```
func GetServerClaim ¶
func GetServerClaim(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerClaimState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*ServerClaim, error)
NewServerClaim registers a new resource with the given unique name, arguments, and options.
func (*ServerClaim) ElementType ¶
func (*ServerClaim) ElementType() reflect.Type
func (*ServerClaim) ToServerClaimOutput ¶
func (i *ServerClaim) ToServerClaimOutput() ServerClaimOutput
func (*ServerClaim) ToServerClaimOutputWithContext ¶
func (i *ServerClaim) ToServerClaimOutputWithContext(ctx context.Context) ServerClaimOutput
type ServerClaimArgs ¶
type ServerClaimArgs struct { // Specifies whether to include claims in token, by default it is set to `true`. AlwaysIncludeInToken pulumi.BoolPtrInput // ID of the authorization server. AuthServerId pulumi.StringInput // Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`. ClaimType pulumi.StringInput // Specifies the type of group filter if `valueType` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`. GroupFilterType pulumi.StringPtrInput // The name of the claim. Name pulumi.StringPtrInput // The list of scopes the auth server claim is tied to. Scopes pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // The value of the claim. Value pulumi.StringInput // The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`. ValueType pulumi.StringPtrInput }
The set of arguments for constructing a ServerClaim resource.
func (ServerClaimArgs) ElementType ¶
func (ServerClaimArgs) ElementType() reflect.Type
type ServerClaimArray ¶
type ServerClaimArray []ServerClaimInput
func (ServerClaimArray) ElementType ¶
func (ServerClaimArray) ElementType() reflect.Type
func (ServerClaimArray) ToServerClaimArrayOutput ¶
func (i ServerClaimArray) ToServerClaimArrayOutput() ServerClaimArrayOutput
func (ServerClaimArray) ToServerClaimArrayOutputWithContext ¶
func (i ServerClaimArray) ToServerClaimArrayOutputWithContext(ctx context.Context) ServerClaimArrayOutput
type ServerClaimArrayInput ¶
type ServerClaimArrayInput interface { pulumi.Input ToServerClaimArrayOutput() ServerClaimArrayOutput ToServerClaimArrayOutputWithContext(context.Context) ServerClaimArrayOutput }
ServerClaimArrayInput is an input type that accepts ServerClaimArray and ServerClaimArrayOutput values. You can construct a concrete instance of `ServerClaimArrayInput` via:
ServerClaimArray{ ServerClaimArgs{...} }
type ServerClaimArrayOutput ¶
type ServerClaimArrayOutput struct{ *pulumi.OutputState }
func (ServerClaimArrayOutput) ElementType ¶
func (ServerClaimArrayOutput) ElementType() reflect.Type
func (ServerClaimArrayOutput) Index ¶
func (o ServerClaimArrayOutput) Index(i pulumi.IntInput) ServerClaimOutput
func (ServerClaimArrayOutput) ToServerClaimArrayOutput ¶
func (o ServerClaimArrayOutput) ToServerClaimArrayOutput() ServerClaimArrayOutput
func (ServerClaimArrayOutput) ToServerClaimArrayOutputWithContext ¶
func (o ServerClaimArrayOutput) ToServerClaimArrayOutputWithContext(ctx context.Context) ServerClaimArrayOutput
type ServerClaimInput ¶
type ServerClaimInput interface { pulumi.Input ToServerClaimOutput() ServerClaimOutput ToServerClaimOutputWithContext(ctx context.Context) ServerClaimOutput }
type ServerClaimMap ¶
type ServerClaimMap map[string]ServerClaimInput
func (ServerClaimMap) ElementType ¶
func (ServerClaimMap) ElementType() reflect.Type
func (ServerClaimMap) ToServerClaimMapOutput ¶
func (i ServerClaimMap) ToServerClaimMapOutput() ServerClaimMapOutput
func (ServerClaimMap) ToServerClaimMapOutputWithContext ¶
func (i ServerClaimMap) ToServerClaimMapOutputWithContext(ctx context.Context) ServerClaimMapOutput
type ServerClaimMapInput ¶
type ServerClaimMapInput interface { pulumi.Input ToServerClaimMapOutput() ServerClaimMapOutput ToServerClaimMapOutputWithContext(context.Context) ServerClaimMapOutput }
ServerClaimMapInput is an input type that accepts ServerClaimMap and ServerClaimMapOutput values. You can construct a concrete instance of `ServerClaimMapInput` via:
ServerClaimMap{ "key": ServerClaimArgs{...} }
type ServerClaimMapOutput ¶
type ServerClaimMapOutput struct{ *pulumi.OutputState }
func (ServerClaimMapOutput) ElementType ¶
func (ServerClaimMapOutput) ElementType() reflect.Type
func (ServerClaimMapOutput) MapIndex ¶
func (o ServerClaimMapOutput) MapIndex(k pulumi.StringInput) ServerClaimOutput
func (ServerClaimMapOutput) ToServerClaimMapOutput ¶
func (o ServerClaimMapOutput) ToServerClaimMapOutput() ServerClaimMapOutput
func (ServerClaimMapOutput) ToServerClaimMapOutputWithContext ¶
func (o ServerClaimMapOutput) ToServerClaimMapOutputWithContext(ctx context.Context) ServerClaimMapOutput
type ServerClaimOutput ¶
type ServerClaimOutput struct{ *pulumi.OutputState }
func (ServerClaimOutput) AlwaysIncludeInToken ¶
func (o ServerClaimOutput) AlwaysIncludeInToken() pulumi.BoolPtrOutput
Specifies whether to include claims in token, by default it is set to `true`.
func (ServerClaimOutput) AuthServerId ¶
func (o ServerClaimOutput) AuthServerId() pulumi.StringOutput
ID of the authorization server.
func (ServerClaimOutput) ClaimType ¶
func (o ServerClaimOutput) ClaimType() pulumi.StringOutput
Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`.
func (ServerClaimOutput) ElementType ¶
func (ServerClaimOutput) ElementType() reflect.Type
func (ServerClaimOutput) GroupFilterType ¶
func (o ServerClaimOutput) GroupFilterType() pulumi.StringPtrOutput
Specifies the type of group filter if `valueType` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`.
func (ServerClaimOutput) Name ¶
func (o ServerClaimOutput) Name() pulumi.StringOutput
The name of the claim.
func (ServerClaimOutput) Scopes ¶
func (o ServerClaimOutput) Scopes() pulumi.StringArrayOutput
The list of scopes the auth server claim is tied to.
func (ServerClaimOutput) Status ¶
func (o ServerClaimOutput) Status() pulumi.StringPtrOutput
Default to `ACTIVE`
func (ServerClaimOutput) ToServerClaimOutput ¶
func (o ServerClaimOutput) ToServerClaimOutput() ServerClaimOutput
func (ServerClaimOutput) ToServerClaimOutputWithContext ¶
func (o ServerClaimOutput) ToServerClaimOutputWithContext(ctx context.Context) ServerClaimOutput
func (ServerClaimOutput) Value ¶
func (o ServerClaimOutput) Value() pulumi.StringOutput
The value of the claim.
func (ServerClaimOutput) ValueType ¶
func (o ServerClaimOutput) ValueType() pulumi.StringPtrOutput
The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`.
type ServerClaimState ¶
type ServerClaimState struct { // Specifies whether to include claims in token, by default it is set to `true`. AlwaysIncludeInToken pulumi.BoolPtrInput // ID of the authorization server. AuthServerId pulumi.StringPtrInput // Specifies whether the claim is for an access token `RESOURCE` or ID token `IDENTITY`. ClaimType pulumi.StringPtrInput // Specifies the type of group filter if `valueType` is `GROUPS`. Can be set to one of the following `STARTS_WITH`, `EQUALS`, `CONTAINS`, `REGEX`. GroupFilterType pulumi.StringPtrInput // The name of the claim. Name pulumi.StringPtrInput // The list of scopes the auth server claim is tied to. Scopes pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // The value of the claim. Value pulumi.StringPtrInput // The type of value of the claim. It can be set to `EXPRESSION` or `GROUPS`. It defaults to `EXPRESSION`. ValueType pulumi.StringPtrInput }
func (ServerClaimState) ElementType ¶
func (ServerClaimState) ElementType() reflect.Type
type ServerInput ¶
type ServerInput interface { pulumi.Input ToServerOutput() ServerOutput ToServerOutputWithContext(ctx context.Context) ServerOutput }
type ServerMap ¶
type ServerMap map[string]ServerInput
func (ServerMap) ElementType ¶
func (ServerMap) ToServerMapOutput ¶
func (i ServerMap) ToServerMapOutput() ServerMapOutput
func (ServerMap) ToServerMapOutputWithContext ¶
func (i ServerMap) ToServerMapOutputWithContext(ctx context.Context) ServerMapOutput
type ServerMapInput ¶
type ServerMapInput interface { pulumi.Input ToServerMapOutput() ServerMapOutput ToServerMapOutputWithContext(context.Context) ServerMapOutput }
ServerMapInput is an input type that accepts ServerMap and ServerMapOutput values. You can construct a concrete instance of `ServerMapInput` via:
ServerMap{ "key": ServerArgs{...} }
type ServerMapOutput ¶
type ServerMapOutput struct{ *pulumi.OutputState }
func (ServerMapOutput) ElementType ¶
func (ServerMapOutput) ElementType() reflect.Type
func (ServerMapOutput) MapIndex ¶
func (o ServerMapOutput) MapIndex(k pulumi.StringInput) ServerOutput
func (ServerMapOutput) ToServerMapOutput ¶
func (o ServerMapOutput) ToServerMapOutput() ServerMapOutput
func (ServerMapOutput) ToServerMapOutputWithContext ¶
func (o ServerMapOutput) ToServerMapOutputWithContext(ctx context.Context) ServerMapOutput
type ServerOutput ¶
type ServerOutput struct{ *pulumi.OutputState }
func (ServerOutput) Audiences ¶
func (o ServerOutput) Audiences() pulumi.StringArrayOutput
The recipients that the tokens are intended for. This becomes the `aud` claim in an access token. Currently Okta only supports a single value here.
func (ServerOutput) CredentialsLastRotated ¶
func (o ServerOutput) CredentialsLastRotated() pulumi.StringOutput
The timestamp when the authorization server started to use the `kid` for signing tokens.
func (ServerOutput) CredentialsNextRotation ¶
func (o ServerOutput) CredentialsNextRotation() pulumi.StringOutput
The timestamp when the authorization server changes the key for signing tokens. Only returned when `credentialsRotationMode` is `AUTO`.
func (ServerOutput) CredentialsRotationMode ¶
func (o ServerOutput) CredentialsRotationMode() pulumi.StringPtrOutput
The key rotation mode for the authorization server. Can be `AUTO` or `MANUAL`. Default: `AUTO`
func (ServerOutput) Description ¶
func (o ServerOutput) Description() pulumi.StringPtrOutput
The description of the authorization server.
func (ServerOutput) ElementType ¶
func (ServerOutput) ElementType() reflect.Type
func (ServerOutput) Issuer ¶
func (o ServerOutput) Issuer() pulumi.StringOutput
The complete URL for a Custom Authorization Server. This becomes the `iss` claim in an access token.
func (ServerOutput) IssuerMode ¶
func (o ServerOutput) IssuerMode() pulumi.StringPtrOutput
*Early Access Property*. Allows you to use a custom issuer URL. It can be set to `CUSTOM_URL`, `ORG_URL`, or `DYNAMIC`. Default: `ORG_URL`
func (ServerOutput) Kid ¶
func (o ServerOutput) Kid() pulumi.StringOutput
The ID of the JSON Web Key used for signing tokens issued by the authorization server.
func (ServerOutput) Name ¶
func (o ServerOutput) Name() pulumi.StringOutput
The name of the authorization server.
func (ServerOutput) Status ¶
func (o ServerOutput) Status() pulumi.StringPtrOutput
Default to `ACTIVE`
func (ServerOutput) ToServerOutput ¶
func (o ServerOutput) ToServerOutput() ServerOutput
func (ServerOutput) ToServerOutputWithContext ¶
func (o ServerOutput) ToServerOutputWithContext(ctx context.Context) ServerOutput
type ServerPolicy ¶
type ServerPolicy struct { pulumi.CustomResourceState // The ID of the Auth Server. AuthServerId pulumi.StringOutput `pulumi:"authServerId"` // The clients to whitelist the policy for. `[ALL_CLIENTS]` is a special value that can be used to whitelist all clients, otherwise it is a list of client ids. ClientWhitelists pulumi.StringArrayOutput `pulumi:"clientWhitelists"` // The description of the Auth Server Policy. Description pulumi.StringOutput `pulumi:"description"` // The name of the Auth Server Policy. Name pulumi.StringOutput `pulumi:"name"` // Priority of the auth server policy Priority pulumi.IntOutput `pulumi:"priority"` // Default to `ACTIVE` Status pulumi.StringPtrOutput `pulumi:"status"` }
Creates an Authorization Server Policy. This resource allows you to create and configure an Authorization Server Policy.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServerPolicy(ctx, "example", &auth.ServerPolicyArgs{ AuthServerId: pulumi.String("<auth server id>"), Status: pulumi.String("ACTIVE"), Name: pulumi.String("example"), Description: pulumi.String("example"), Priority: pulumi.Int(1), ClientWhitelists: pulumi.StringArray{ pulumi.String("ALL_CLIENTS"), }, }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/serverPolicy:ServerPolicy example <auth_server_id>/<policy_id> ```
func GetServerPolicy ¶
func GetServerPolicy(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerPolicyState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*ServerPolicy, error)
NewServerPolicy registers a new resource with the given unique name, arguments, and options.
func (*ServerPolicy) ElementType ¶
func (*ServerPolicy) ElementType() reflect.Type
func (*ServerPolicy) ToServerPolicyOutput ¶
func (i *ServerPolicy) ToServerPolicyOutput() ServerPolicyOutput
func (*ServerPolicy) ToServerPolicyOutputWithContext ¶
func (i *ServerPolicy) ToServerPolicyOutputWithContext(ctx context.Context) ServerPolicyOutput
type ServerPolicyArgs ¶
type ServerPolicyArgs struct { // The ID of the Auth Server. AuthServerId pulumi.StringInput // The clients to whitelist the policy for. `[ALL_CLIENTS]` is a special value that can be used to whitelist all clients, otherwise it is a list of client ids. ClientWhitelists pulumi.StringArrayInput // The description of the Auth Server Policy. Description pulumi.StringInput // The name of the Auth Server Policy. Name pulumi.StringPtrInput // Priority of the auth server policy Priority pulumi.IntInput // Default to `ACTIVE` Status pulumi.StringPtrInput }
The set of arguments for constructing a ServerPolicy resource.
func (ServerPolicyArgs) ElementType ¶
func (ServerPolicyArgs) ElementType() reflect.Type
type ServerPolicyArray ¶
type ServerPolicyArray []ServerPolicyInput
func (ServerPolicyArray) ElementType ¶
func (ServerPolicyArray) ElementType() reflect.Type
func (ServerPolicyArray) ToServerPolicyArrayOutput ¶
func (i ServerPolicyArray) ToServerPolicyArrayOutput() ServerPolicyArrayOutput
func (ServerPolicyArray) ToServerPolicyArrayOutputWithContext ¶
func (i ServerPolicyArray) ToServerPolicyArrayOutputWithContext(ctx context.Context) ServerPolicyArrayOutput
type ServerPolicyArrayInput ¶
type ServerPolicyArrayInput interface { pulumi.Input ToServerPolicyArrayOutput() ServerPolicyArrayOutput ToServerPolicyArrayOutputWithContext(context.Context) ServerPolicyArrayOutput }
ServerPolicyArrayInput is an input type that accepts ServerPolicyArray and ServerPolicyArrayOutput values. You can construct a concrete instance of `ServerPolicyArrayInput` via:
ServerPolicyArray{ ServerPolicyArgs{...} }
type ServerPolicyArrayOutput ¶
type ServerPolicyArrayOutput struct{ *pulumi.OutputState }
func (ServerPolicyArrayOutput) ElementType ¶
func (ServerPolicyArrayOutput) ElementType() reflect.Type
func (ServerPolicyArrayOutput) Index ¶
func (o ServerPolicyArrayOutput) Index(i pulumi.IntInput) ServerPolicyOutput
func (ServerPolicyArrayOutput) ToServerPolicyArrayOutput ¶
func (o ServerPolicyArrayOutput) ToServerPolicyArrayOutput() ServerPolicyArrayOutput
func (ServerPolicyArrayOutput) ToServerPolicyArrayOutputWithContext ¶
func (o ServerPolicyArrayOutput) ToServerPolicyArrayOutputWithContext(ctx context.Context) ServerPolicyArrayOutput
type ServerPolicyClaim
deprecated
type ServerPolicyClaim struct { pulumi.CustomResourceState // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrOutput `pulumi:"accessTokenLifetimeMinutes"` // Auth server ID AuthServerId pulumi.StringOutput `pulumi:"authServerId"` // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayOutput `pulumi:"grantTypeWhitelists"` // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayOutput `pulumi:"groupBlacklists"` // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayOutput `pulumi:"groupWhitelists"` // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrOutput `pulumi:"inlineHookId"` // Auth server policy rule name Name pulumi.StringOutput `pulumi:"name"` // Auth server policy ID PolicyId pulumi.StringOutput `pulumi:"policyId"` // Priority of the auth server policy rule Priority pulumi.IntOutput `pulumi:"priority"` // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrOutput `pulumi:"refreshTokenLifetimeMinutes"` // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrOutput `pulumi:"refreshTokenWindowMinutes"` // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayOutput `pulumi:"scopeWhitelists"` // Default to `ACTIVE` Status pulumi.StringPtrOutput `pulumi:"status"` // The rule is the system (default) rule for its associated policy System pulumi.BoolOutput `pulumi:"system"` // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrOutput `pulumi:"type"` // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayOutput `pulumi:"userBlacklists"` // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayOutput `pulumi:"userWhitelists"` }
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServerPolicyRule(ctx, "example", &auth.ServerPolicyRuleArgs{ AuthServerId: pulumi.String("<auth server id>"), PolicyId: pulumi.String("<auth server policy id>"), Status: pulumi.String("ACTIVE"), Name: pulumi.String("example"), Priority: pulumi.Int(1), GroupWhitelists: pulumi.StringArray{ pulumi.String("<group ids>"), }, GrantTypeWhitelists: pulumi.StringArray{ pulumi.String("implicit"), }, }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/serverPolicyClaim:ServerPolicyClaim example <auth_server_id>/<policy_id>/<policy_rule_id> ```
Deprecated: okta.auth/serverpolicyclaim.ServerPolicyClaim has been deprecated in favor of okta.auth/serverpolicyrule.ServerPolicyRule
func GetServerPolicyClaim ¶
func GetServerPolicyClaim(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerPolicyClaimState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*ServerPolicyClaim, error)
NewServerPolicyClaim registers a new resource with the given unique name, arguments, and options.
func (*ServerPolicyClaim) ElementType ¶
func (*ServerPolicyClaim) ElementType() reflect.Type
func (*ServerPolicyClaim) ToServerPolicyClaimOutput ¶
func (i *ServerPolicyClaim) ToServerPolicyClaimOutput() ServerPolicyClaimOutput
func (*ServerPolicyClaim) ToServerPolicyClaimOutputWithContext ¶
func (i *ServerPolicyClaim) ToServerPolicyClaimOutputWithContext(ctx context.Context) ServerPolicyClaimOutput
type ServerPolicyClaimArgs ¶
type ServerPolicyClaimArgs struct { // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrInput // Auth server ID AuthServerId pulumi.StringInput // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayInput // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrInput // Auth server policy rule name Name pulumi.StringPtrInput // Auth server policy ID PolicyId pulumi.StringInput // Priority of the auth server policy rule Priority pulumi.IntInput // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrInput // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrInput // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrInput // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayInput // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayInput }
The set of arguments for constructing a ServerPolicyClaim resource.
func (ServerPolicyClaimArgs) ElementType ¶
func (ServerPolicyClaimArgs) ElementType() reflect.Type
type ServerPolicyClaimArray ¶
type ServerPolicyClaimArray []ServerPolicyClaimInput
func (ServerPolicyClaimArray) ElementType ¶
func (ServerPolicyClaimArray) ElementType() reflect.Type
func (ServerPolicyClaimArray) ToServerPolicyClaimArrayOutput ¶
func (i ServerPolicyClaimArray) ToServerPolicyClaimArrayOutput() ServerPolicyClaimArrayOutput
func (ServerPolicyClaimArray) ToServerPolicyClaimArrayOutputWithContext ¶
func (i ServerPolicyClaimArray) ToServerPolicyClaimArrayOutputWithContext(ctx context.Context) ServerPolicyClaimArrayOutput
type ServerPolicyClaimArrayInput ¶
type ServerPolicyClaimArrayInput interface { pulumi.Input ToServerPolicyClaimArrayOutput() ServerPolicyClaimArrayOutput ToServerPolicyClaimArrayOutputWithContext(context.Context) ServerPolicyClaimArrayOutput }
ServerPolicyClaimArrayInput is an input type that accepts ServerPolicyClaimArray and ServerPolicyClaimArrayOutput values. You can construct a concrete instance of `ServerPolicyClaimArrayInput` via:
ServerPolicyClaimArray{ ServerPolicyClaimArgs{...} }
type ServerPolicyClaimArrayOutput ¶
type ServerPolicyClaimArrayOutput struct{ *pulumi.OutputState }
func (ServerPolicyClaimArrayOutput) ElementType ¶
func (ServerPolicyClaimArrayOutput) ElementType() reflect.Type
func (ServerPolicyClaimArrayOutput) Index ¶
func (o ServerPolicyClaimArrayOutput) Index(i pulumi.IntInput) ServerPolicyClaimOutput
func (ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutput ¶
func (o ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutput() ServerPolicyClaimArrayOutput
func (ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutputWithContext ¶
func (o ServerPolicyClaimArrayOutput) ToServerPolicyClaimArrayOutputWithContext(ctx context.Context) ServerPolicyClaimArrayOutput
type ServerPolicyClaimInput ¶
type ServerPolicyClaimInput interface { pulumi.Input ToServerPolicyClaimOutput() ServerPolicyClaimOutput ToServerPolicyClaimOutputWithContext(ctx context.Context) ServerPolicyClaimOutput }
type ServerPolicyClaimMap ¶
type ServerPolicyClaimMap map[string]ServerPolicyClaimInput
func (ServerPolicyClaimMap) ElementType ¶
func (ServerPolicyClaimMap) ElementType() reflect.Type
func (ServerPolicyClaimMap) ToServerPolicyClaimMapOutput ¶
func (i ServerPolicyClaimMap) ToServerPolicyClaimMapOutput() ServerPolicyClaimMapOutput
func (ServerPolicyClaimMap) ToServerPolicyClaimMapOutputWithContext ¶
func (i ServerPolicyClaimMap) ToServerPolicyClaimMapOutputWithContext(ctx context.Context) ServerPolicyClaimMapOutput
type ServerPolicyClaimMapInput ¶
type ServerPolicyClaimMapInput interface { pulumi.Input ToServerPolicyClaimMapOutput() ServerPolicyClaimMapOutput ToServerPolicyClaimMapOutputWithContext(context.Context) ServerPolicyClaimMapOutput }
ServerPolicyClaimMapInput is an input type that accepts ServerPolicyClaimMap and ServerPolicyClaimMapOutput values. You can construct a concrete instance of `ServerPolicyClaimMapInput` via:
ServerPolicyClaimMap{ "key": ServerPolicyClaimArgs{...} }
type ServerPolicyClaimMapOutput ¶
type ServerPolicyClaimMapOutput struct{ *pulumi.OutputState }
func (ServerPolicyClaimMapOutput) ElementType ¶
func (ServerPolicyClaimMapOutput) ElementType() reflect.Type
func (ServerPolicyClaimMapOutput) MapIndex ¶
func (o ServerPolicyClaimMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyClaimOutput
func (ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutput ¶
func (o ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutput() ServerPolicyClaimMapOutput
func (ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutputWithContext ¶
func (o ServerPolicyClaimMapOutput) ToServerPolicyClaimMapOutputWithContext(ctx context.Context) ServerPolicyClaimMapOutput
type ServerPolicyClaimOutput ¶
type ServerPolicyClaimOutput struct{ *pulumi.OutputState }
func (ServerPolicyClaimOutput) AccessTokenLifetimeMinutes ¶
func (o ServerPolicyClaimOutput) AccessTokenLifetimeMinutes() pulumi.IntPtrOutput
Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`.
func (ServerPolicyClaimOutput) AuthServerId ¶
func (o ServerPolicyClaimOutput) AuthServerId() pulumi.StringOutput
Auth server ID
func (ServerPolicyClaimOutput) ElementType ¶
func (ServerPolicyClaimOutput) ElementType() reflect.Type
func (ServerPolicyClaimOutput) GrantTypeWhitelists ¶
func (o ServerPolicyClaimOutput) GrantTypeWhitelists() pulumi.StringArrayOutput
Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set.
func (ServerPolicyClaimOutput) GroupBlacklists ¶
func (o ServerPolicyClaimOutput) GroupBlacklists() pulumi.StringArrayOutput
Specifies a set of Groups whose Users are to be excluded.
func (ServerPolicyClaimOutput) GroupWhitelists ¶
func (o ServerPolicyClaimOutput) GroupWhitelists() pulumi.StringArrayOutput
Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`.
func (ServerPolicyClaimOutput) InlineHookId ¶
func (o ServerPolicyClaimOutput) InlineHookId() pulumi.StringPtrOutput
The ID of the inline token to trigger.
func (ServerPolicyClaimOutput) Name ¶
func (o ServerPolicyClaimOutput) Name() pulumi.StringOutput
Auth server policy rule name
func (ServerPolicyClaimOutput) PolicyId ¶
func (o ServerPolicyClaimOutput) PolicyId() pulumi.StringOutput
Auth server policy ID
func (ServerPolicyClaimOutput) Priority ¶
func (o ServerPolicyClaimOutput) Priority() pulumi.IntOutput
Priority of the auth server policy rule
func (ServerPolicyClaimOutput) RefreshTokenLifetimeMinutes ¶
func (o ServerPolicyClaimOutput) RefreshTokenLifetimeMinutes() pulumi.IntPtrOutput
Lifetime of refresh token.
func (ServerPolicyClaimOutput) RefreshTokenWindowMinutes ¶
func (o ServerPolicyClaimOutput) RefreshTokenWindowMinutes() pulumi.IntPtrOutput
Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`.
func (ServerPolicyClaimOutput) ScopeWhitelists ¶
func (o ServerPolicyClaimOutput) ScopeWhitelists() pulumi.StringArrayOutput
Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*`
func (ServerPolicyClaimOutput) Status ¶
func (o ServerPolicyClaimOutput) Status() pulumi.StringPtrOutput
Default to `ACTIVE`
func (ServerPolicyClaimOutput) System ¶ added in v4.6.0
func (o ServerPolicyClaimOutput) System() pulumi.BoolOutput
The rule is the system (default) rule for its associated policy
func (ServerPolicyClaimOutput) ToServerPolicyClaimOutput ¶
func (o ServerPolicyClaimOutput) ToServerPolicyClaimOutput() ServerPolicyClaimOutput
func (ServerPolicyClaimOutput) ToServerPolicyClaimOutputWithContext ¶
func (o ServerPolicyClaimOutput) ToServerPolicyClaimOutputWithContext(ctx context.Context) ServerPolicyClaimOutput
func (ServerPolicyClaimOutput) Type ¶
func (o ServerPolicyClaimOutput) Type() pulumi.StringPtrOutput
Auth server policy rule type, unlikely this will be anything other then the default
func (ServerPolicyClaimOutput) UserBlacklists ¶
func (o ServerPolicyClaimOutput) UserBlacklists() pulumi.StringArrayOutput
Specifies a set of Users to be excluded.
func (ServerPolicyClaimOutput) UserWhitelists ¶
func (o ServerPolicyClaimOutput) UserWhitelists() pulumi.StringArrayOutput
Specifies a set of Users to be included.
type ServerPolicyClaimState ¶
type ServerPolicyClaimState struct { // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrInput // Auth server ID AuthServerId pulumi.StringPtrInput // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayInput // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrInput // Auth server policy rule name Name pulumi.StringPtrInput // Auth server policy ID PolicyId pulumi.StringPtrInput // Priority of the auth server policy rule Priority pulumi.IntPtrInput // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrInput // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrInput // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // The rule is the system (default) rule for its associated policy System pulumi.BoolPtrInput // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrInput // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayInput // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayInput }
func (ServerPolicyClaimState) ElementType ¶
func (ServerPolicyClaimState) ElementType() reflect.Type
type ServerPolicyInput ¶
type ServerPolicyInput interface { pulumi.Input ToServerPolicyOutput() ServerPolicyOutput ToServerPolicyOutputWithContext(ctx context.Context) ServerPolicyOutput }
type ServerPolicyMap ¶
type ServerPolicyMap map[string]ServerPolicyInput
func (ServerPolicyMap) ElementType ¶
func (ServerPolicyMap) ElementType() reflect.Type
func (ServerPolicyMap) ToServerPolicyMapOutput ¶
func (i ServerPolicyMap) ToServerPolicyMapOutput() ServerPolicyMapOutput
func (ServerPolicyMap) ToServerPolicyMapOutputWithContext ¶
func (i ServerPolicyMap) ToServerPolicyMapOutputWithContext(ctx context.Context) ServerPolicyMapOutput
type ServerPolicyMapInput ¶
type ServerPolicyMapInput interface { pulumi.Input ToServerPolicyMapOutput() ServerPolicyMapOutput ToServerPolicyMapOutputWithContext(context.Context) ServerPolicyMapOutput }
ServerPolicyMapInput is an input type that accepts ServerPolicyMap and ServerPolicyMapOutput values. You can construct a concrete instance of `ServerPolicyMapInput` via:
ServerPolicyMap{ "key": ServerPolicyArgs{...} }
type ServerPolicyMapOutput ¶
type ServerPolicyMapOutput struct{ *pulumi.OutputState }
func (ServerPolicyMapOutput) ElementType ¶
func (ServerPolicyMapOutput) ElementType() reflect.Type
func (ServerPolicyMapOutput) MapIndex ¶
func (o ServerPolicyMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyOutput
func (ServerPolicyMapOutput) ToServerPolicyMapOutput ¶
func (o ServerPolicyMapOutput) ToServerPolicyMapOutput() ServerPolicyMapOutput
func (ServerPolicyMapOutput) ToServerPolicyMapOutputWithContext ¶
func (o ServerPolicyMapOutput) ToServerPolicyMapOutputWithContext(ctx context.Context) ServerPolicyMapOutput
type ServerPolicyOutput ¶
type ServerPolicyOutput struct{ *pulumi.OutputState }
func (ServerPolicyOutput) AuthServerId ¶
func (o ServerPolicyOutput) AuthServerId() pulumi.StringOutput
The ID of the Auth Server.
func (ServerPolicyOutput) ClientWhitelists ¶
func (o ServerPolicyOutput) ClientWhitelists() pulumi.StringArrayOutput
The clients to whitelist the policy for. `[ALL_CLIENTS]` is a special value that can be used to whitelist all clients, otherwise it is a list of client ids.
func (ServerPolicyOutput) Description ¶
func (o ServerPolicyOutput) Description() pulumi.StringOutput
The description of the Auth Server Policy.
func (ServerPolicyOutput) ElementType ¶
func (ServerPolicyOutput) ElementType() reflect.Type
func (ServerPolicyOutput) Name ¶
func (o ServerPolicyOutput) Name() pulumi.StringOutput
The name of the Auth Server Policy.
func (ServerPolicyOutput) Priority ¶
func (o ServerPolicyOutput) Priority() pulumi.IntOutput
Priority of the auth server policy
func (ServerPolicyOutput) Status ¶
func (o ServerPolicyOutput) Status() pulumi.StringPtrOutput
Default to `ACTIVE`
func (ServerPolicyOutput) ToServerPolicyOutput ¶
func (o ServerPolicyOutput) ToServerPolicyOutput() ServerPolicyOutput
func (ServerPolicyOutput) ToServerPolicyOutputWithContext ¶
func (o ServerPolicyOutput) ToServerPolicyOutputWithContext(ctx context.Context) ServerPolicyOutput
type ServerPolicyRule ¶
type ServerPolicyRule struct { pulumi.CustomResourceState // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrOutput `pulumi:"accessTokenLifetimeMinutes"` // Auth server ID AuthServerId pulumi.StringOutput `pulumi:"authServerId"` // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayOutput `pulumi:"grantTypeWhitelists"` // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayOutput `pulumi:"groupBlacklists"` // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayOutput `pulumi:"groupWhitelists"` // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrOutput `pulumi:"inlineHookId"` // Auth server policy rule name Name pulumi.StringOutput `pulumi:"name"` // Auth server policy ID PolicyId pulumi.StringOutput `pulumi:"policyId"` // Priority of the auth server policy rule Priority pulumi.IntOutput `pulumi:"priority"` // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrOutput `pulumi:"refreshTokenLifetimeMinutes"` // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrOutput `pulumi:"refreshTokenWindowMinutes"` // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayOutput `pulumi:"scopeWhitelists"` // Default to `ACTIVE` Status pulumi.StringPtrOutput `pulumi:"status"` // The rule is the system (default) rule for its associated policy System pulumi.BoolOutput `pulumi:"system"` // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrOutput `pulumi:"type"` // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayOutput `pulumi:"userBlacklists"` // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayOutput `pulumi:"userWhitelists"` }
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServerPolicyRule(ctx, "example", &auth.ServerPolicyRuleArgs{ AuthServerId: pulumi.String("<auth server id>"), PolicyId: pulumi.String("<auth server policy id>"), Status: pulumi.String("ACTIVE"), Name: pulumi.String("example"), Priority: pulumi.Int(1), GroupWhitelists: pulumi.StringArray{ pulumi.String("<group ids>"), }, GrantTypeWhitelists: pulumi.StringArray{ pulumi.String("implicit"), }, }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/serverPolicyRule:ServerPolicyRule example <auth_server_id>/<policy_id>/<policy_rule_id> ```
func GetServerPolicyRule ¶
func GetServerPolicyRule(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerPolicyRuleState, opts ...pulumi.ResourceOption) (*ServerPolicyRule, error)
GetServerPolicyRule gets an existing ServerPolicyRule 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 NewServerPolicyRule ¶
func NewServerPolicyRule(ctx *pulumi.Context, name string, args *ServerPolicyRuleArgs, opts ...pulumi.ResourceOption) (*ServerPolicyRule, error)
NewServerPolicyRule registers a new resource with the given unique name, arguments, and options.
func (*ServerPolicyRule) ElementType ¶
func (*ServerPolicyRule) ElementType() reflect.Type
func (*ServerPolicyRule) ToServerPolicyRuleOutput ¶
func (i *ServerPolicyRule) ToServerPolicyRuleOutput() ServerPolicyRuleOutput
func (*ServerPolicyRule) ToServerPolicyRuleOutputWithContext ¶
func (i *ServerPolicyRule) ToServerPolicyRuleOutputWithContext(ctx context.Context) ServerPolicyRuleOutput
type ServerPolicyRuleArgs ¶
type ServerPolicyRuleArgs struct { // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrInput // Auth server ID AuthServerId pulumi.StringInput // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayInput // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrInput // Auth server policy rule name Name pulumi.StringPtrInput // Auth server policy ID PolicyId pulumi.StringInput // Priority of the auth server policy rule Priority pulumi.IntInput // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrInput // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrInput // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrInput // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayInput // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayInput }
The set of arguments for constructing a ServerPolicyRule resource.
func (ServerPolicyRuleArgs) ElementType ¶
func (ServerPolicyRuleArgs) ElementType() reflect.Type
type ServerPolicyRuleArray ¶
type ServerPolicyRuleArray []ServerPolicyRuleInput
func (ServerPolicyRuleArray) ElementType ¶
func (ServerPolicyRuleArray) ElementType() reflect.Type
func (ServerPolicyRuleArray) ToServerPolicyRuleArrayOutput ¶
func (i ServerPolicyRuleArray) ToServerPolicyRuleArrayOutput() ServerPolicyRuleArrayOutput
func (ServerPolicyRuleArray) ToServerPolicyRuleArrayOutputWithContext ¶
func (i ServerPolicyRuleArray) ToServerPolicyRuleArrayOutputWithContext(ctx context.Context) ServerPolicyRuleArrayOutput
type ServerPolicyRuleArrayInput ¶
type ServerPolicyRuleArrayInput interface { pulumi.Input ToServerPolicyRuleArrayOutput() ServerPolicyRuleArrayOutput ToServerPolicyRuleArrayOutputWithContext(context.Context) ServerPolicyRuleArrayOutput }
ServerPolicyRuleArrayInput is an input type that accepts ServerPolicyRuleArray and ServerPolicyRuleArrayOutput values. You can construct a concrete instance of `ServerPolicyRuleArrayInput` via:
ServerPolicyRuleArray{ ServerPolicyRuleArgs{...} }
type ServerPolicyRuleArrayOutput ¶
type ServerPolicyRuleArrayOutput struct{ *pulumi.OutputState }
func (ServerPolicyRuleArrayOutput) ElementType ¶
func (ServerPolicyRuleArrayOutput) ElementType() reflect.Type
func (ServerPolicyRuleArrayOutput) Index ¶
func (o ServerPolicyRuleArrayOutput) Index(i pulumi.IntInput) ServerPolicyRuleOutput
func (ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutput ¶
func (o ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutput() ServerPolicyRuleArrayOutput
func (ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutputWithContext ¶
func (o ServerPolicyRuleArrayOutput) ToServerPolicyRuleArrayOutputWithContext(ctx context.Context) ServerPolicyRuleArrayOutput
type ServerPolicyRuleInput ¶
type ServerPolicyRuleInput interface { pulumi.Input ToServerPolicyRuleOutput() ServerPolicyRuleOutput ToServerPolicyRuleOutputWithContext(ctx context.Context) ServerPolicyRuleOutput }
type ServerPolicyRuleMap ¶
type ServerPolicyRuleMap map[string]ServerPolicyRuleInput
func (ServerPolicyRuleMap) ElementType ¶
func (ServerPolicyRuleMap) ElementType() reflect.Type
func (ServerPolicyRuleMap) ToServerPolicyRuleMapOutput ¶
func (i ServerPolicyRuleMap) ToServerPolicyRuleMapOutput() ServerPolicyRuleMapOutput
func (ServerPolicyRuleMap) ToServerPolicyRuleMapOutputWithContext ¶
func (i ServerPolicyRuleMap) ToServerPolicyRuleMapOutputWithContext(ctx context.Context) ServerPolicyRuleMapOutput
type ServerPolicyRuleMapInput ¶
type ServerPolicyRuleMapInput interface { pulumi.Input ToServerPolicyRuleMapOutput() ServerPolicyRuleMapOutput ToServerPolicyRuleMapOutputWithContext(context.Context) ServerPolicyRuleMapOutput }
ServerPolicyRuleMapInput is an input type that accepts ServerPolicyRuleMap and ServerPolicyRuleMapOutput values. You can construct a concrete instance of `ServerPolicyRuleMapInput` via:
ServerPolicyRuleMap{ "key": ServerPolicyRuleArgs{...} }
type ServerPolicyRuleMapOutput ¶
type ServerPolicyRuleMapOutput struct{ *pulumi.OutputState }
func (ServerPolicyRuleMapOutput) ElementType ¶
func (ServerPolicyRuleMapOutput) ElementType() reflect.Type
func (ServerPolicyRuleMapOutput) MapIndex ¶
func (o ServerPolicyRuleMapOutput) MapIndex(k pulumi.StringInput) ServerPolicyRuleOutput
func (ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutput ¶
func (o ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutput() ServerPolicyRuleMapOutput
func (ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutputWithContext ¶
func (o ServerPolicyRuleMapOutput) ToServerPolicyRuleMapOutputWithContext(ctx context.Context) ServerPolicyRuleMapOutput
type ServerPolicyRuleOutput ¶
type ServerPolicyRuleOutput struct{ *pulumi.OutputState }
func (ServerPolicyRuleOutput) AccessTokenLifetimeMinutes ¶
func (o ServerPolicyRuleOutput) AccessTokenLifetimeMinutes() pulumi.IntPtrOutput
Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`.
func (ServerPolicyRuleOutput) AuthServerId ¶
func (o ServerPolicyRuleOutput) AuthServerId() pulumi.StringOutput
Auth server ID
func (ServerPolicyRuleOutput) ElementType ¶
func (ServerPolicyRuleOutput) ElementType() reflect.Type
func (ServerPolicyRuleOutput) GrantTypeWhitelists ¶
func (o ServerPolicyRuleOutput) GrantTypeWhitelists() pulumi.StringArrayOutput
Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set.
func (ServerPolicyRuleOutput) GroupBlacklists ¶
func (o ServerPolicyRuleOutput) GroupBlacklists() pulumi.StringArrayOutput
Specifies a set of Groups whose Users are to be excluded.
func (ServerPolicyRuleOutput) GroupWhitelists ¶
func (o ServerPolicyRuleOutput) GroupWhitelists() pulumi.StringArrayOutput
Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`.
func (ServerPolicyRuleOutput) InlineHookId ¶
func (o ServerPolicyRuleOutput) InlineHookId() pulumi.StringPtrOutput
The ID of the inline token to trigger.
func (ServerPolicyRuleOutput) Name ¶
func (o ServerPolicyRuleOutput) Name() pulumi.StringOutput
Auth server policy rule name
func (ServerPolicyRuleOutput) PolicyId ¶
func (o ServerPolicyRuleOutput) PolicyId() pulumi.StringOutput
Auth server policy ID
func (ServerPolicyRuleOutput) Priority ¶
func (o ServerPolicyRuleOutput) Priority() pulumi.IntOutput
Priority of the auth server policy rule
func (ServerPolicyRuleOutput) RefreshTokenLifetimeMinutes ¶
func (o ServerPolicyRuleOutput) RefreshTokenLifetimeMinutes() pulumi.IntPtrOutput
Lifetime of refresh token.
func (ServerPolicyRuleOutput) RefreshTokenWindowMinutes ¶
func (o ServerPolicyRuleOutput) RefreshTokenWindowMinutes() pulumi.IntPtrOutput
Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`.
func (ServerPolicyRuleOutput) ScopeWhitelists ¶
func (o ServerPolicyRuleOutput) ScopeWhitelists() pulumi.StringArrayOutput
Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*`
func (ServerPolicyRuleOutput) Status ¶
func (o ServerPolicyRuleOutput) Status() pulumi.StringPtrOutput
Default to `ACTIVE`
func (ServerPolicyRuleOutput) System ¶ added in v4.6.0
func (o ServerPolicyRuleOutput) System() pulumi.BoolOutput
The rule is the system (default) rule for its associated policy
func (ServerPolicyRuleOutput) ToServerPolicyRuleOutput ¶
func (o ServerPolicyRuleOutput) ToServerPolicyRuleOutput() ServerPolicyRuleOutput
func (ServerPolicyRuleOutput) ToServerPolicyRuleOutputWithContext ¶
func (o ServerPolicyRuleOutput) ToServerPolicyRuleOutputWithContext(ctx context.Context) ServerPolicyRuleOutput
func (ServerPolicyRuleOutput) Type ¶
func (o ServerPolicyRuleOutput) Type() pulumi.StringPtrOutput
Auth server policy rule type, unlikely this will be anything other then the default
func (ServerPolicyRuleOutput) UserBlacklists ¶
func (o ServerPolicyRuleOutput) UserBlacklists() pulumi.StringArrayOutput
Specifies a set of Users to be excluded.
func (ServerPolicyRuleOutput) UserWhitelists ¶
func (o ServerPolicyRuleOutput) UserWhitelists() pulumi.StringArrayOutput
Specifies a set of Users to be included.
type ServerPolicyRuleState ¶
type ServerPolicyRuleState struct { // Lifetime of access token. Can be set to a value between 5 and 1440 minutes. Default is `60`. AccessTokenLifetimeMinutes pulumi.IntPtrInput // Auth server ID AuthServerId pulumi.StringPtrInput // Accepted grant type values, `authorizationCode`, `implicit`, `password`, `clientCredentials`, `urn:ietf:params:oauth:grant-type:saml2-bearer` (*Early Access Property*), `urn:ietf:params:oauth:grant-type:token-exchange` (*Early Access Property*),`urn:ietf:params:oauth:grant-type:device_code` (*Early Access Property*), `interactionCode` (*OIE only*). For `implicit` value either `userWhitelist` or `groupWhitelist` should be set. GrantTypeWhitelists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be excluded. GroupBlacklists pulumi.StringArrayInput // Specifies a set of Groups whose Users are to be included. Can be set to Group ID or to the following: `EVERYONE`. GroupWhitelists pulumi.StringArrayInput // The ID of the inline token to trigger. InlineHookId pulumi.StringPtrInput // Auth server policy rule name Name pulumi.StringPtrInput // Auth server policy ID PolicyId pulumi.StringPtrInput // Priority of the auth server policy rule Priority pulumi.IntPtrInput // Lifetime of refresh token. RefreshTokenLifetimeMinutes pulumi.IntPtrInput // Window in which a refresh token can be used. It can be a value between 5 and 2628000 (5 years) minutes. Default is `10080` (7 days).`refreshTokenWindowMinutes` must be between `accessTokenLifetimeMinutes` and `refreshTokenLifetimeMinutes`. RefreshTokenWindowMinutes pulumi.IntPtrInput // Scopes allowed for this policy rule. They can be whitelisted by name or all can be whitelisted with `*` ScopeWhitelists pulumi.StringArrayInput // Default to `ACTIVE` Status pulumi.StringPtrInput // The rule is the system (default) rule for its associated policy System pulumi.BoolPtrInput // Auth server policy rule type, unlikely this will be anything other then the default Type pulumi.StringPtrInput // Specifies a set of Users to be excluded. UserBlacklists pulumi.StringArrayInput // Specifies a set of Users to be included. UserWhitelists pulumi.StringArrayInput }
func (ServerPolicyRuleState) ElementType ¶
func (ServerPolicyRuleState) ElementType() reflect.Type
type ServerPolicyState ¶
type ServerPolicyState struct { // The ID of the Auth Server. AuthServerId pulumi.StringPtrInput // The clients to whitelist the policy for. `[ALL_CLIENTS]` is a special value that can be used to whitelist all clients, otherwise it is a list of client ids. ClientWhitelists pulumi.StringArrayInput // The description of the Auth Server Policy. Description pulumi.StringPtrInput // The name of the Auth Server Policy. Name pulumi.StringPtrInput // Priority of the auth server policy Priority pulumi.IntPtrInput // Default to `ACTIVE` Status pulumi.StringPtrInput }
func (ServerPolicyState) ElementType ¶
func (ServerPolicyState) ElementType() reflect.Type
type ServerScope ¶
type ServerScope struct { pulumi.CustomResourceState // Auth server ID AuthServerId pulumi.StringOutput `pulumi:"authServerId"` // Indicates whether a consent dialog is needed for the scope. It can be set to `REQUIRED` or `IMPLICIT`. Default: `IMPLICIT` Consent pulumi.StringPtrOutput `pulumi:"consent"` // 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 pulumi.BoolPtrOutput `pulumi:"default"` // Description of the Auth Server Scope. Description pulumi.StringPtrOutput `pulumi:"description"` // Name of the end user displayed in a consent dialog box DisplayName pulumi.StringPtrOutput `pulumi:"displayName"` // Whether to publish metadata or not. It can be set to `ALL_CLIENTS` or `NO_CLIENTS`. Default: `ALL_CLIENTS` MetadataPublish pulumi.StringPtrOutput `pulumi:"metadataPublish"` // Auth server scope name Name pulumi.StringOutput `pulumi:"name"` // Whether the scope optional Optional pulumi.BoolPtrOutput `pulumi:"optional"` // Whether Okta created the Scope System pulumi.BoolOutput `pulumi:"system"` }
Creates an Authorization Server Scope. This resource allows you to create and configure an Authorization Server Scope.
## Example Usage
```go package main
import (
"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/auth" "github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() { pulumi.Run(func(ctx *pulumi.Context) error { _, err := auth.NewServerScope(ctx, "example", &auth.ServerScopeArgs{ AuthServerId: pulumi.String("<auth server id>"), MetadataPublish: pulumi.String("NO_CLIENTS"), Name: pulumi.String("example"), Consent: pulumi.String("IMPLICIT"), }) if err != nil { return err } return nil }) }
```
## Import
```sh $ pulumi import okta:auth/serverScope:ServerScope example <auth_server_id>/<scope_id> ```
func GetServerScope ¶
func GetServerScope(ctx *pulumi.Context, name string, id pulumi.IDInput, state *ServerScopeState, opts ...pulumi.ResourceOption) (*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.ResourceOption) (*ServerScope, error)
NewServerScope registers a new resource with the given unique name, arguments, and options.
func (*ServerScope) ElementType ¶
func (*ServerScope) ElementType() reflect.Type
func (*ServerScope) ToServerScopeOutput ¶
func (i *ServerScope) ToServerScopeOutput() ServerScopeOutput
func (*ServerScope) ToServerScopeOutputWithContext ¶
func (i *ServerScope) ToServerScopeOutputWithContext(ctx context.Context) ServerScopeOutput
type ServerScopeArgs ¶
type ServerScopeArgs struct { // Auth server ID AuthServerId pulumi.StringInput // Indicates whether a consent dialog is needed for the scope. It can be set to `REQUIRED` or `IMPLICIT`. Default: `IMPLICIT` Consent pulumi.StringPtrInput // 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 pulumi.BoolPtrInput // Description of the Auth Server Scope. Description pulumi.StringPtrInput // Name of the end user displayed in a consent dialog box DisplayName pulumi.StringPtrInput // Whether to publish metadata or not. It can be set to `ALL_CLIENTS` or `NO_CLIENTS`. Default: `ALL_CLIENTS` MetadataPublish pulumi.StringPtrInput // Auth server scope name Name pulumi.StringPtrInput // Whether the scope optional Optional pulumi.BoolPtrInput }
The set of arguments for constructing a ServerScope resource.
func (ServerScopeArgs) ElementType ¶
func (ServerScopeArgs) ElementType() reflect.Type
type ServerScopeArray ¶
type ServerScopeArray []ServerScopeInput
func (ServerScopeArray) ElementType ¶
func (ServerScopeArray) ElementType() reflect.Type
func (ServerScopeArray) ToServerScopeArrayOutput ¶
func (i ServerScopeArray) ToServerScopeArrayOutput() ServerScopeArrayOutput
func (ServerScopeArray) ToServerScopeArrayOutputWithContext ¶
func (i ServerScopeArray) ToServerScopeArrayOutputWithContext(ctx context.Context) ServerScopeArrayOutput
type ServerScopeArrayInput ¶
type ServerScopeArrayInput interface { pulumi.Input ToServerScopeArrayOutput() ServerScopeArrayOutput ToServerScopeArrayOutputWithContext(context.Context) ServerScopeArrayOutput }
ServerScopeArrayInput is an input type that accepts ServerScopeArray and ServerScopeArrayOutput values. You can construct a concrete instance of `ServerScopeArrayInput` via:
ServerScopeArray{ ServerScopeArgs{...} }
type ServerScopeArrayOutput ¶
type ServerScopeArrayOutput struct{ *pulumi.OutputState }
func (ServerScopeArrayOutput) ElementType ¶
func (ServerScopeArrayOutput) ElementType() reflect.Type
func (ServerScopeArrayOutput) Index ¶
func (o ServerScopeArrayOutput) Index(i pulumi.IntInput) ServerScopeOutput
func (ServerScopeArrayOutput) ToServerScopeArrayOutput ¶
func (o ServerScopeArrayOutput) ToServerScopeArrayOutput() ServerScopeArrayOutput
func (ServerScopeArrayOutput) ToServerScopeArrayOutputWithContext ¶
func (o ServerScopeArrayOutput) ToServerScopeArrayOutputWithContext(ctx context.Context) ServerScopeArrayOutput
type ServerScopeInput ¶
type ServerScopeInput interface { pulumi.Input ToServerScopeOutput() ServerScopeOutput ToServerScopeOutputWithContext(ctx context.Context) ServerScopeOutput }
type ServerScopeMap ¶
type ServerScopeMap map[string]ServerScopeInput
func (ServerScopeMap) ElementType ¶
func (ServerScopeMap) ElementType() reflect.Type
func (ServerScopeMap) ToServerScopeMapOutput ¶
func (i ServerScopeMap) ToServerScopeMapOutput() ServerScopeMapOutput
func (ServerScopeMap) ToServerScopeMapOutputWithContext ¶
func (i ServerScopeMap) ToServerScopeMapOutputWithContext(ctx context.Context) ServerScopeMapOutput
type ServerScopeMapInput ¶
type ServerScopeMapInput interface { pulumi.Input ToServerScopeMapOutput() ServerScopeMapOutput ToServerScopeMapOutputWithContext(context.Context) ServerScopeMapOutput }
ServerScopeMapInput is an input type that accepts ServerScopeMap and ServerScopeMapOutput values. You can construct a concrete instance of `ServerScopeMapInput` via:
ServerScopeMap{ "key": ServerScopeArgs{...} }
type ServerScopeMapOutput ¶
type ServerScopeMapOutput struct{ *pulumi.OutputState }
func (ServerScopeMapOutput) ElementType ¶
func (ServerScopeMapOutput) ElementType() reflect.Type
func (ServerScopeMapOutput) MapIndex ¶
func (o ServerScopeMapOutput) MapIndex(k pulumi.StringInput) ServerScopeOutput
func (ServerScopeMapOutput) ToServerScopeMapOutput ¶
func (o ServerScopeMapOutput) ToServerScopeMapOutput() ServerScopeMapOutput
func (ServerScopeMapOutput) ToServerScopeMapOutputWithContext ¶
func (o ServerScopeMapOutput) ToServerScopeMapOutputWithContext(ctx context.Context) ServerScopeMapOutput
type ServerScopeOutput ¶
type ServerScopeOutput struct{ *pulumi.OutputState }
func (ServerScopeOutput) AuthServerId ¶
func (o ServerScopeOutput) AuthServerId() pulumi.StringOutput
Auth server ID
func (ServerScopeOutput) Consent ¶
func (o ServerScopeOutput) Consent() pulumi.StringPtrOutput
Indicates whether a consent dialog is needed for the scope. It can be set to `REQUIRED` or `IMPLICIT`. Default: `IMPLICIT`
func (ServerScopeOutput) Default ¶
func (o ServerScopeOutput) Default() pulumi.BoolPtrOutput
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 (ServerScopeOutput) Description ¶
func (o ServerScopeOutput) Description() pulumi.StringPtrOutput
Description of the Auth Server Scope.
func (ServerScopeOutput) DisplayName ¶
func (o ServerScopeOutput) DisplayName() pulumi.StringPtrOutput
Name of the end user displayed in a consent dialog box
func (ServerScopeOutput) ElementType ¶
func (ServerScopeOutput) ElementType() reflect.Type
func (ServerScopeOutput) MetadataPublish ¶
func (o ServerScopeOutput) MetadataPublish() pulumi.StringPtrOutput
Whether to publish metadata or not. It can be set to `ALL_CLIENTS` or `NO_CLIENTS`. Default: `ALL_CLIENTS`
func (ServerScopeOutput) Name ¶
func (o ServerScopeOutput) Name() pulumi.StringOutput
Auth server scope name
func (ServerScopeOutput) Optional ¶ added in v4.4.0
func (o ServerScopeOutput) Optional() pulumi.BoolPtrOutput
Whether the scope optional
func (ServerScopeOutput) System ¶
func (o ServerScopeOutput) System() pulumi.BoolOutput
Whether Okta created the Scope
func (ServerScopeOutput) ToServerScopeOutput ¶
func (o ServerScopeOutput) ToServerScopeOutput() ServerScopeOutput
func (ServerScopeOutput) ToServerScopeOutputWithContext ¶
func (o ServerScopeOutput) ToServerScopeOutputWithContext(ctx context.Context) ServerScopeOutput
type ServerScopeState ¶
type ServerScopeState struct { // Auth server ID AuthServerId pulumi.StringPtrInput // Indicates whether a consent dialog is needed for the scope. It can be set to `REQUIRED` or `IMPLICIT`. Default: `IMPLICIT` Consent pulumi.StringPtrInput // 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 pulumi.BoolPtrInput // Description of the Auth Server Scope. Description pulumi.StringPtrInput // Name of the end user displayed in a consent dialog box DisplayName pulumi.StringPtrInput // Whether to publish metadata or not. It can be set to `ALL_CLIENTS` or `NO_CLIENTS`. Default: `ALL_CLIENTS` MetadataPublish pulumi.StringPtrInput // Auth server scope name Name pulumi.StringPtrInput // Whether the scope optional Optional pulumi.BoolPtrInput // Whether Okta created the Scope System pulumi.BoolPtrInput }
func (ServerScopeState) ElementType ¶
func (ServerScopeState) ElementType() reflect.Type
type ServerState ¶
type ServerState struct { // The recipients that the tokens are intended for. This becomes the `aud` claim in an access token. Currently Okta only supports a single value here. Audiences pulumi.StringArrayInput // The timestamp when the authorization server started to use the `kid` for signing tokens. CredentialsLastRotated pulumi.StringPtrInput // The timestamp when the authorization server changes the key for signing tokens. Only returned when `credentialsRotationMode` is `AUTO`. CredentialsNextRotation pulumi.StringPtrInput // The key rotation mode for the authorization server. Can be `AUTO` or `MANUAL`. Default: `AUTO` CredentialsRotationMode pulumi.StringPtrInput // The description of the authorization server. Description pulumi.StringPtrInput // The complete URL for a Custom Authorization Server. This becomes the `iss` claim in an access token. Issuer pulumi.StringPtrInput // *Early Access Property*. Allows you to use a custom issuer URL. It can be set to `CUSTOM_URL`, `ORG_URL`, or `DYNAMIC`. Default: `ORG_URL` IssuerMode pulumi.StringPtrInput // The ID of the JSON Web Key used for signing tokens issued by the authorization server. Kid pulumi.StringPtrInput // The name of the authorization server. Name pulumi.StringPtrInput // Default to `ACTIVE` Status pulumi.StringPtrInput }
func (ServerState) ElementType ¶
func (ServerState) ElementType() reflect.Type