1. Docs
  2. Reference
  3. API
  4. Okta
  5. inline
  6. Hook

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 = new Okta.Inline.Inputs.HookAuthArgs
            {
                Key = "Authorization",
                Type = "HEADER",
                Value = "secret",
            },
            Channel = new Okta.Inline.Inputs.HookChannelArgs
            {
                Method = "POST",
                Uri = "https://example.com/test",
                Version = "1.0.0",
            },
            Type = "com.okta.oauth2.tokens.transform",
            Version = "1.0.1",
        });
    }

}

Coming soon!

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.1")
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.1",
});

Create a Hook Resource

new Hook(name: string, args: HookArgs, opts?: CustomResourceOptions);
def Hook(resource_name, opts=None, auth=None, channel=None, headers=None, name=None, status=None, type=None, version=None, __props__=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.
opts ResourceOptions
A bag of options that control this 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:

Type string

The type of hook to trigger. Currently only "HTTP" is supported.

Version string

The version of the endpoint.

Auth HookAuthArgs

Authentication required for inline hook request.

Channel HookChannelArgs

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 only "HTTP" is supported.

Version string

The version of the endpoint.

Auth HookAuth

Authentication required for inline hook request.

Channel HookChannel

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 only "HTTP" is supported.

version string

The version of the endpoint.

auth HookAuth

Authentication required for inline hook request.

channel HookChannel

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 str

The type of hook to trigger. Currently only "HTTP" is supported.

version str

The version of the endpoint.

auth Dict[HookAuth]

Authentication required for inline hook request.

channel Dict[HookChannel]

Details of the endpoint the inline hook will hit.

headers List[HookHeader]

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
static get(resource_name, id, opts=None, auth=None, channel=None, headers=None, name=None, status=None, type=None, version=None, __props__=None);
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 HookAuthArgs

Authentication required for inline hook request.

Channel HookChannelArgs

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 only "HTTP" is supported.

Version string

The version of the endpoint.

Auth HookAuth

Authentication required for inline hook request.

Channel HookChannel

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 only "HTTP" is supported.

Version string

The version of the endpoint.

auth HookAuth

Authentication required for inline hook request.

channel HookChannel

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 only "HTTP" is supported.

version string

The version of the endpoint.

auth Dict[HookAuth]

Authentication required for inline hook request.

channel Dict[HookChannel]

Details of the endpoint the inline hook will hit.

headers List[HookHeader]

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 only "HTTP" is supported.

version str

The version of the endpoint.

Supporting Types

HookAuth

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Key string

Key to use for authentication, usually the header name, for example "Authorization".

Type string

The type of hook to trigger. Currently only "HTTP" is supported.

Value string

Authentication secret.

Key string

Key to use for authentication, usually the header name, for example "Authorization".

Type string

The type of hook to trigger. Currently only "HTTP" is supported.

Value string

Authentication secret.

key string

Key to use for authentication, usually the header name, for example "Authorization".

type string

The type of hook to trigger. Currently only "HTTP" is supported.

value string

Authentication secret.

key str

Key to use for authentication, usually the header name, for example "Authorization".

type str

The type of hook to trigger. Currently only "HTTP" is supported.

value str

Authentication secret.

HookChannel

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Uri string

The URI the hook will hit.

Version string

The version of the endpoint.

Method string

The request method to use. Default is "POST".

Type bool

The type of hook to trigger. Currently only "HTTP" is supported.

Uri string

The URI the hook will hit.

Version string

The version of the endpoint.

Method string

The request method to use. Default is "POST".

Type bool

The type of hook to trigger. Currently only "HTTP" is supported.

uri string

The URI the hook will hit.

version string

The version of the endpoint.

method string

The request method to use. Default is "POST".

type boolean

The type of hook to trigger. Currently only "HTTP" is supported.

uri str

The URI the hook will hit.

version str

The version of the endpoint.

method str

The request method to use. Default is "POST".

type bool

The type of hook to trigger. Currently only "HTTP" is supported.

HookHeader

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

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.

Package Details

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