log_stream_schemas

Creates, updates, deletes, gets or lists a log_stream_schemas resource.

Overview

Name	log_stream_schemas
Type	Resource
Id	okta.meta.log_stream_schemas

Fields

The following fields are returned by SELECT queries:

get_log_stream_schema

successful operation

Name	Datatype	Description
id	string	URI of log stream schema
$schema	string	JSON schema version identifier
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
errorMessage	string	A collection of error messages for individual properties in the schema. Okta implements a subset of ajv-errors. (opaque JSON object)
oneOf	array	Non-empty array of valid JSON schemas. Okta only supports oneOf for specifying display names for an enum. Each schema has the following format: { "const": "enumValue", "title": "display name" }
pattern	string	For string log stream schema property type, specifies the regular expression used to validate the property
properties	string	log stream schema properties object (opaque JSON object)
required	array	Required properties for this log stream schema object
title	string	Name of the log streaming integration
type	string	Type of log stream schema property

list_log_stream_schemas

Name	Datatype	Description
id	string	URI of log stream schema
$schema	string	JSON schema version identifier
_links	object	Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations.
errorMessage	string	A collection of error messages for individual properties in the schema. Okta implements a subset of ajv-errors. (opaque JSON object)
oneOf	array	Non-empty array of valid JSON schemas. Okta only supports oneOf for specifying display names for an enum. Each schema has the following format: { "const": "enumValue", "title": "display name" }
pattern	string	For string log stream schema property type, specifies the regular expression used to validate the property
properties	string	log stream schema properties object (opaque JSON object)
required	array	Required properties for this log stream schema object
title	string	Name of the log streaming integration
type	string	Type of log stream schema property

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_log_stream_schema	select	logStreamType, subdomain		Retrieves the schema for a log stream type. The logStreamType element in the URL specifies the log stream type, which is either aws_eventbridge or splunk_cloud_logstreaming. Use the aws_eventbridge literal to retrieve the AWS EventBridge type schema, and use the splunk_cloud_logstreaming literal retrieve the Splunk Cloud type schema.
list_log_stream_schemas	select	subdomain		Lists the schema for all log stream types visible for this org

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
logStreamType	string
subdomain	string	(default: my-org)

SELECT examples

get_log_stream_schema

Retrieves the schema for a log stream type. The logStreamType element in the URL specifies the log stream type, which is either aws_eventbridge or splunk_cloud_logstreaming. Use the aws_eventbridge literal to retrieve the AWS EventBridge type schema, and use the splunk_cloud_logstreaming literal retrieve the Splunk Cloud type schema.

SELECT
id,
$schema,
_links,
errorMessage,
oneOf,
pattern,
properties,
required,
title,
type
FROM okta.meta.log_stream_schemas
WHERE logStreamType = '{{ logStreamType }}' -- required
AND subdomain = '{{ subdomain }}' -- required
;

list_log_stream_schemas

Lists the schema for all log stream types visible for this org

SELECT
id,
$schema,
_links,
errorMessage,
oneOf,
pattern,
properties,
required,
title,
type
FROM okta.meta.log_stream_schemas
WHERE subdomain = '{{ subdomain }}' -- required
;