1. Docs
  2. Reference
  3. API
  4. @pulumi/okta
  5. inline

Module inline

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-okta repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-okta repo.

Resources

Others

Resources

Resource Hook

class Hook extends CustomResource

Creates an inline hook.

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

Example Usage

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

constructor

new Hook(name: string, args: HookArgs, opts?: pulumi.CustomResourceOptions)

Create a Hook resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: HookState, opts?: pulumi.CustomResourceOptions): Hook

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Hook

Returns true if the given object is an instance of Hook. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property auth

public auth: pulumi.Output<HookAuth | undefined>;

Authentication required for inline hook request.

property channel

public channel: pulumi.Output<HookChannel | undefined>;

Details of the endpoint the inline hook will hit.

property headers

public headers: pulumi.Output<HookHeader[] | undefined>;

Map of headers to send along in inline hook request.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The inline hook display name.

property status

public status: pulumi.Output<string | undefined>;

property type

public type: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property version

public version: pulumi.Output<string>;

The version of the endpoint.

Others

interface HookArgs

interface HookArgs

The set of arguments for constructing a Hook resource.

property auth

auth?: pulumi.Input<HookAuth>;

Authentication required for inline hook request.

property channel

channel?: pulumi.Input<HookChannel>;

Details of the endpoint the inline hook will hit.

property headers

headers?: pulumi.Input<pulumi.Input<HookHeader>[]>;

Map of headers to send along in inline hook request.

property name

name?: pulumi.Input<string>;

The inline hook display name.

property status

status?: pulumi.Input<string>;

property type

type: pulumi.Input<string>;

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

property version

version: pulumi.Input<string>;

The version of the endpoint.

interface HookState

interface HookState

Input properties used for looking up and filtering Hook resources.

property auth

auth?: pulumi.Input<HookAuth>;

Authentication required for inline hook request.

property channel

channel?: pulumi.Input<HookChannel>;

Details of the endpoint the inline hook will hit.

property headers

headers?: pulumi.Input<pulumi.Input<HookHeader>[]>;

Map of headers to send along in inline hook request.

property name

name?: pulumi.Input<string>;

The inline hook display name.

property status

status?: pulumi.Input<string>;

property type

type?: pulumi.Input<string>;

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

property version

version?: pulumi.Input<string>;

The version of the endpoint.