Hook

Creates an inline hook.

This resource allows you to create and configure an inline hook.

Example Usage

using Pulumi;
using Okta = Pulumi.Okta;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Okta.Inline.Hook("example", new Okta.Inline.HookArgs
        {
            Auth = 
            {
                { "key", "Authorization" },
                { "type", "HEADER" },
                { "value", "secret" },
            },
            Channel = 
            {
                { "method", "POST" },
                { "uri", "https://example.com/test" },
                { "version", "1.0.0" },
            },
            Type = "com.okta.oauth2.tokens.transform",
            Version = "1.0.0",
        });
    }

}
package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v3/go/okta/inline"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := inline.NewHook(ctx, "example", &inline.HookArgs{
			Auth: pulumi.StringMap{
				"key":   pulumi.String("Authorization"),
				"type":  pulumi.String("HEADER"),
				"value": pulumi.String("secret"),
			},
			Channel: pulumi.StringMap{
				"method":  pulumi.String("POST"),
				"uri":     pulumi.String("https://example.com/test"),
				"version": pulumi.String("1.0.0"),
			},
			Type:    pulumi.String("com.okta.oauth2.tokens.transform"),
			Version: pulumi.String("1.0.0"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_okta as okta

example = okta.inline.Hook("example",
    auth={
        "key": "Authorization",
        "type": "HEADER",
        "value": "secret",
    },
    channel={
        "method": "POST",
        "uri": "https://example.com/test",
        "version": "1.0.0",
    },
    type="com.okta.oauth2.tokens.transform",
    version="1.0.0")
import * as pulumi from "@pulumi/pulumi";
import * as okta from "@pulumi/okta";

const example = new okta.inline.Hook("example", {
    auth: {
        key: "Authorization",
        type: "HEADER",
        value: "secret",
    },
    channel: {
        method: "POST",
        uri: "https://example.com/test",
        version: "1.0.0",
    },
    type: "com.okta.oauth2.tokens.transform",
    version: "1.0.0",
});

Create a Hook Resource

new Hook(name: string, args: HookArgs, opts?: CustomResourceOptions);
@overload
def Hook(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         auth: Optional[Mapping[str, str]] = None,
         channel: Optional[Mapping[str, str]] = None,
         headers: Optional[Sequence[HookHeaderArgs]] = None,
         name: Optional[str] = None,
         status: Optional[str] = None,
         type: Optional[str] = None,
         version: Optional[str] = None)
@overload
def Hook(resource_name: str,
         args: HookArgs,
         opts: Optional[ResourceOptions] = None)
func NewHook(ctx *Context, name string, args HookArgs, opts ...ResourceOption) (*Hook, error)
public Hook(string name, HookArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args HookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args HookArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args HookArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args HookArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Hook Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Hook resource accepts the following input properties:

Channel Dictionary<string, string>
Details of the endpoint the inline hook will hit.
Type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
Version string
Version of the channel. The currently-supported version is "1.0.0".
Auth Dictionary<string, string>
Authentication required for inline hook request.
Headers List<HookHeaderArgs>
Map of headers to send along in inline hook request.
Name string
The inline hook display name.
Status string
Channel map[string]string
Details of the endpoint the inline hook will hit.
Type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
Version string
Version of the channel. The currently-supported version is "1.0.0".
Auth map[string]string
Authentication required for inline hook request.
Headers []HookHeader
Map of headers to send along in inline hook request.
Name string
The inline hook display name.
Status string
channel {[key: string]: string}
Details of the endpoint the inline hook will hit.
type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
version string
Version of the channel. The currently-supported version is "1.0.0".
auth {[key: string]: string}
Authentication required for inline hook request.
headers HookHeaderArgs[]
Map of headers to send along in inline hook request.
name string
The inline hook display name.
status string
channel Mapping[str, str]
Details of the endpoint the inline hook will hit.
type str
The type of hook to trigger. Currently, the only supported type is "HTTP".
version str
Version of the channel. The currently-supported version is "1.0.0".
auth Mapping[str, str]
Authentication required for inline hook request.
headers Sequence[HookHeaderArgs]
Map of headers to send along in inline hook request.
name str
The inline hook display name.
status str

Outputs

All input properties are implicitly available as output properties. Additionally, the Hook resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.

Look up an Existing Hook Resource

Get an existing Hook resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HookState, opts?: CustomResourceOptions): Hook
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        auth: Optional[Mapping[str, str]] = None,
        channel: Optional[Mapping[str, str]] = None,
        headers: Optional[Sequence[HookHeaderArgs]] = None,
        name: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        version: Optional[str] = None) -> Hook
func GetHook(ctx *Context, name string, id IDInput, state *HookState, opts ...ResourceOption) (*Hook, error)
public static Hook Get(string name, Input<string> id, HookState? state, CustomResourceOptions? opts = null)
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.

The following state arguments are supported:

Auth Dictionary<string, string>
Authentication required for inline hook request.
Channel Dictionary<string, string>
Details of the endpoint the inline hook will hit.
Headers List<HookHeaderArgs>
Map of headers to send along in inline hook request.
Name string
The inline hook display name.
Status string
Type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
Version string
Version of the channel. The currently-supported version is "1.0.0".
Auth map[string]string
Authentication required for inline hook request.
Channel map[string]string
Details of the endpoint the inline hook will hit.
Headers []HookHeader
Map of headers to send along in inline hook request.
Name string
The inline hook display name.
Status string
Type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
Version string
Version of the channel. The currently-supported version is "1.0.0".
auth {[key: string]: string}
Authentication required for inline hook request.
channel {[key: string]: string}
Details of the endpoint the inline hook will hit.
headers HookHeaderArgs[]
Map of headers to send along in inline hook request.
name string
The inline hook display name.
status string
type string
The type of hook to trigger. Currently, the only supported type is "HTTP".
version string
Version of the channel. The currently-supported version is "1.0.0".
auth Mapping[str, str]
Authentication required for inline hook request.
channel Mapping[str, str]
Details of the endpoint the inline hook will hit.
headers Sequence[HookHeaderArgs]
Map of headers to send along in inline hook request.
name str
The inline hook display name.
status str
type str
The type of hook to trigger. Currently, the only supported type is "HTTP".
version str
Version of the channel. The currently-supported version is "1.0.0".

Supporting Types

HookHeader

Key string
Key to use for authentication, usually the header name, for example "Authorization".
Value string
Authentication secret.
Key string
Key to use for authentication, usually the header name, for example "Authorization".
Value string
Authentication secret.
key string
Key to use for authentication, usually the header name, for example "Authorization".
value string
Authentication secret.
key str
Key to use for authentication, usually the header name, for example "Authorization".
value str
Authentication secret.

Import

An inline hook can be imported via the Okta ID.

 $ pulumi import okta:inline/hook:Hook example <hook id>

Package Details

Repository
https://github.com/pulumi/pulumi-okta
License
Apache-2.0
Notes
This Pulumi package is based on the okta Terraform Provider.