1. Docs
  2. Reference
  3. API
  4. pulumi_okta
  5. inline

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.

class pulumi_okta.inline.Hook(resource_name, opts=None, auth=None, channel=None, headers=None, name=None, status=None, type=None, version=None, __props__=None, __name__=None, __opts__=None)

Creates an inline hook.

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

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")
Parameters

  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth (pulumi.Input[dict]) – Authentication required for inline hook request.

  • channel (pulumi.Input[dict]) – Details of the endpoint the inline hook will hit.

  • headers (pulumi.Input[list]) – Map of headers to send along in inline hook request.

  • name (pulumi.Input[str]) – The inline hook display name.

  • type (pulumi.Input[str]) – The type of hook to trigger. Currently only "HTTP" is supported.

  • version (pulumi.Input[str]) – The version of the endpoint.

The auth object supports the following:

  • key (pulumi.Input[str]) - Key to use for authentication, usually the header name, for example "Authorization".

  • type (pulumi.Input[str]) - The type of hook to trigger. Currently only "HTTP" is supported.

  • value (pulumi.Input[str]) - Authentication secret.

The channel object supports the following:

  • method (pulumi.Input[str]) - The request method to use. Default is "POST".

  • type (pulumi.Input[bool]) - The type of hook to trigger. Currently only "HTTP" is supported.

  • uri (pulumi.Input[str]) - The URI the hook will hit.

  • version (pulumi.Input[str]) - The version of the endpoint.

The headers object supports the following:

  • key (pulumi.Input[str]) - Key to use for authentication, usually the header name, for example "Authorization".

  • value (pulumi.Input[str]) - Authentication secret.

auth: pulumi.Output[dict] = None

Authentication required for inline hook request.

  • 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.

channel: pulumi.Output[dict] = None

Details of the endpoint the inline hook will hit.

  • method (str) - The request method to use. Default is "POST".

  • type (bool) - 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.

headers: pulumi.Output[list] = None

Map of headers to send along in inline hook request.

  • key (str) - Key to use for authentication, usually the header name, for example "Authorization".

  • value (str) - Authentication secret.

name: pulumi.Output[str] = None

The inline hook display name.

type: pulumi.Output[str] = None

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

version: pulumi.Output[str] = None

The version of the endpoint.

static get(resource_name, id, opts=None, auth=None, channel=None, headers=None, name=None, status=None, type=None, version=None)

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

Parameters

  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • auth (pulumi.Input[dict]) – Authentication required for inline hook request.

  • channel (pulumi.Input[dict]) – Details of the endpoint the inline hook will hit.

  • headers (pulumi.Input[list]) – Map of headers to send along in inline hook request.

  • name (pulumi.Input[str]) – The inline hook display name.

  • type (pulumi.Input[str]) – The type of hook to trigger. Currently only "HTTP" is supported.

  • version (pulumi.Input[str]) – The version of the endpoint.

The auth object supports the following:

  • key (pulumi.Input[str]) - Key to use for authentication, usually the header name, for example "Authorization".

  • type (pulumi.Input[str]) - The type of hook to trigger. Currently only "HTTP" is supported.

  • value (pulumi.Input[str]) - Authentication secret.

The channel object supports the following:

  • method (pulumi.Input[str]) - The request method to use. Default is "POST".

  • type (pulumi.Input[bool]) - The type of hook to trigger. Currently only "HTTP" is supported.

  • uri (pulumi.Input[str]) - The URI the hook will hit.

  • version (pulumi.Input[str]) - The version of the endpoint.

The headers object supports the following:

  • key (pulumi.Input[str]) - Key to use for authentication, usually the header name, for example "Authorization".

  • value (pulumi.Input[str]) - Authentication secret.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str