bundleconfig.json

description: JavaScript only. Set to true to produce a source map.

description: JavaScript only. Sets a root path for source maps.

description: JavaScript only. Gets or sets a flag indicating whether to always escape non-ASCII characters as \uXXXX or to let the output encoding object handle that via the JsEncoderFallback object for the specified output encoding format.

description: JavaScript only.

enum: ignore makeAllSafe makeImmediateSafe

default: ignore

description: JavaScript only.

description: JavaScript only. Controls if local variables should be shortened.

description: Forces all rules to be terminated with semicolons if set to true.

$ref: #/definitions/ajaxminBaseSettings

description: CSS only. If no color names are to be used, set this value to 'hex'. If a set of colors recognized by all major browser is okay to use (W3C-strict validation is not required), set this value to 'major'.

enum: hex major noSwap strict

default: strict

description: CSS only. How to treat comments in the code. The default is 'none', which will strip all comments except 'important' comments. 'all' will leave all comments, and 'hacks' will only leave certain known comment-based hacks.

enum: none all hacks important

default: important

description: CSS only. Adjust relative paths inside the url() function.

description: HTML only. Remove values from boolean attributes.

description: HTML only. Indicating whether to collapse whitespaces.

description: HTML only. Indicating whether the parsing is occurring on an HTML fragment, to avoid creating missing tags (like html, body, head).

description: HTML only. Indicating whether to keep one space when collapsing.

description: HTML only. Minify CSS code in style tags.

description: HTML only. Minify JS code in script tags.

description: HTML only. Minify CSS code in style attributes.

description: HTML only. Preserve case of tag and attribute names.

description: HTML only. Remove all HTML comments except conditional, noindex, Knockout.js containerless comments and Angular.js comment directives.

description: HTML only. Remove optional end tags.

description: HTML only. Indicating whether to remove quoted attributes when possible.

description: For the multi-line output feature, how many spaces to use when indenting a block (see outputMode).

description: SingleLine minifies everything to a single line. MultipleLines breaks the minified code into multiple lines for easier reading.

enum: multipleLines singleLine none

default: singleLine

required: outputFileName inputFiles

description: Set to true to include the output file in the project. Doesn't work in some Visual Studio project types like ASP.NET Core applications.

description: One or more relative file names or globbing patterns to bundle. Example: "scripts/**/*.js"

description: Specify options for minification of the output file.

description: Produce a .gz file after minification.

description: The relative path to the desired output file name.

$ref: #/definitions/jsBundle

$ref: #/definitions/cssBundle

$ref: #/definitions/htmlBundle

description: Schema for bundleconfig.json files

$ref: #/definitions/bundle


clab.schema.json

title: Containerlab topology definition file

type: object

description: topology node configuration container

markdownDescription: topology [node](https://containerlab.dev/manual/nodes/) configuration container

type: string

description: container image to use for this node

markdownDescription: container [image](https://containerlab.dev/manual/nodes/#image) to use for this node

description: policy for pulling the referenced cotnainer image

markdownDescription: container [image-pull-policy](https://containerlab.dev/manual/nodes/#image-pull-policy) to use for this node

enum: always Always never Never ifnotpresent IfNotPresent

type: array

description: list of subject alternative names (SAN) to use for this node

markdownDescription: list of [subject alternative names](https://containerlab.dev/manual/nodes/#subject-alternative-names) to use for this node

description: kind of this node

markdownDescription: [kind](https://containerlab.dev/manual/nodes/#kind) of this node

description: path to a license file

markdownDescription: path to a [license](https://containerlab.dev/manual/nodes/#license) file

description: type is a per-node property that can select a special type of a node

description: grouping parameter of a node. A free form string that is mainly used in sorting elements when graphing

markdownDescription: path to a [license](https://containerlab.dev/manual/nodes/#group) file

description: path to a startup config file (if supported by the kind)

markdownDescription: path to a startup [config file](https://containerlab.dev/manual/nodes/#startup-config) (if supported by the kind)

type: integer

description: Optional startup delay (seconds) to apply

markdownDescription: Optional [startup delay](https://containerlab.dev/manual/nodes/#startup-delay) in seconds

type: boolean

description: Set to `true` to make the node to boot with a startup-config even if the config file is present in the lab directory

markdownDescription: Set to `true` to [make the node to boot with a startup-config](https://containerlab.dev/manual/nodes/#enforce-startup-config) even if the config file is present in the lab directory

description: Set to `true` to remove the node automatically, instead of auto-restarting

markdownDescription: Set to `true` to [remove the node/container automatically](https://containerlab.dev/manual/nodes/#auto-remove), instead of auto-restarting it

description: list of commands to execute post deploy

markdownDescription: list of [commands to execute](https://containerlab.dev/manual/nodes/#exec) post deploy

description: list of file/directory bindings

markdownDescription: list of file/directory [bindings](https://containerlab.dev/manual/nodes/#binds)

description: list of port mappings

markdownDescription: list of [port](https://containerlab.dev/manual/nodes/#ports) mappings

description: environment variables

type: number

description: user to use within the container

markdownDescription: [user](https://containerlab.dev/manual/nodes/#user) to use within the container

description: container's entrypoint

description: command to launch container with

markdownDescription: [command](https://containerlab.dev/manual/nodes/#cmd) to launch container with

description: list of ports to publish

markdownDescription: list of ports to [publish](https://containerlab.dev/manual/nodes/#publish)

description: container labels

description: Runtime used to launch the container node

markdownDescription: [Runtime](https://containerlab.dev/manual/nodes/#runtime) for the node

enum: docker ignite

description: IPv4 management address of the node (e.g. 172.10.10.11)

markdownDescription: [IPv4 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv4) of the node (e.g. 172.10.10.11)

description: IPv6 management address of the node (e.g. 172.10.10.11)

markdownDescription: [IPv6 management address](https://containerlab.dev/manual/nodes/#mgmt-ipv6) of the node (e.g. 172.10.10.11)

description: node network mode (can only be set host, defaults to bridge)

markdownDescription: node [network mode](https://containerlab.dev/manual/nodes/#network-mode) (can only be set host, defaults to bridge)

description: number of vcpu to allocate for this node/container

markdownDescription: Allowed [CPU](https://containerlab.dev/manual/nodes/#cpu) usage by the node/container

description: memory limit for this node/container

markdownDescription: Allowed [Memory](https://containerlab.dev/manual/nodes/#memory) usage by the node/container

description: CPU cores to use by this node/container

markdownDescription: [CPU cores](https://containerlab.dev/manual/nodes/#cpu-set) to be used by the node/container

description: ignite's sandbox image name

description: ignite's kernel image name

$ref: #/definitions/extras-config

$ref: #/definitions/config-config

description: Define which nodes should be started before this node will start

markdownDescription: [wait-for](https://containerlab.dev/manual/nodes/#cmd) defines which nodes should be started before this node will start

$ref: #/definitions/dns-config

$ref: #/definitions/certificate-config

description: type of a node

description: link configuration container

markdownDescription: link configuration container

description: endpoints list

description: link-scoped variables used by config engine

markdownDescription: link-scoped variables used by config engine

description: node's extra configurations

description: list of SR Linux agent's config files to be copied to the NOS filesystem

markdownDescription: list of [SR Linux agent's config files](https://containerlab.dev/manual/kinds/srl/#user-defined-custom-agents-for-sr-linux-nodes) to be copied to the NOS filesystem

description: http/s proxy to be used by mysocketctl

description: containerlab config engine parameters

description: config variables passed to config engine

markdownDescription: config variables passed to config engine

description: Node's Certificate configuration option

markdownDescription: Node's [Certificate configuration options](https://containerlab.dev/manual/nodes/#certificate)

description: Set to `true` to generate a TLS certificate for the node

markdownDescription: Set to `true` to [generate a TLS certificate for the node](https://containerlab.dev/manual/nodes/#certificate)

description: Node's DNS configuration option

markdownDescription: Node's [DNS configuration options](https://containerlab.dev/manual/nodes/#dns)

description: DNS server addresses

description: DNS search domains

description: DNS options

description: Certificate Authority

description: Path to the CA certificate file. If set, it is expected that the CA certificate already exists by that path

description: Path to the CA key file. If set, it is expected that the CA certificate already exists by that path

description: Key size. Can only be set if the external CA certificate is not provided

description: CA certificate validity duration. Can only be set if the external CA certificate is not provided

required: cert key

description: topology name

description: lab prefix

description: configuration container for management network

markdownDescription: configuration container for [management network](https://containerlab.dev/manual/network/#management-network)

description: management network name

description: Set bridge to use for the management network (instead of the default generated bridge).

markdownDescription: Set [bridge](https://containerlab.dev/manual/network/#bridge-name) to use for the management network (instead of the default generated bridge).

description: IPv4 subnet to use for the custom management network. e.g. 172.100.100.0/24

markdownDescription: [IPv4 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to use for the custom management network. e.g. 172.100.100.0/24

description: IPv6 subnet to use for the custom management network. e.g. 2001:172:100:100::/64

markdownDescription: [IPv6 subnet](https://containerlab.dev/manual/network/#user-defined-addresses) to be used for the custom management network. e.g. 2001:172:100:100::/64

description: IPv4 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default

description: IPv6 gateway address that will be set on a bridge used for the management network. Will be set to the first available IP address by default

description: IPv4 range out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25

markdownDescription: [IPv4 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv4-subnet to use for the custom management network. e.g. 172.100.100.128/25

description: IPv6 range out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65

markdownDescription: [IPv6 range](https://containerlab.dev/manual/network/#ip-range) out of the ipv6-subnet to use for the custom management network. e.g. 2001:172:100:100:8000::/65

description: MTU for the custom network

markdownDescription: [MTU](https://containerlab.dev/manual/network/#mtu) in Bytes for the custom management network

description: topology configuration container

description: topology nodes configuration container

markdownDescription: topology [nodes](https://containerlab.dev/manual/nodes/) configuration container

$ref: #/definitions/node-config

description: topology kinds configuration container

markdownDescription: topology [kinds](https://containerlab.dev/manual/topo-def-file/#kinds) configuration container

description: topology links section

description: Global containerlab settings


block.json

title: JSON schema for WordPress blocks

description:
The version of the Block API used by the block. The most recent version is 3 and it was introduced in WordPress 6.3.

 See the API versions documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-api-versions/ for more details.

description: The name for a block is a unique string that identifies a block. Names have to be structured as `namespace/block-name`, where namespace is the name of your plugin or theme.

description: The name of the experiment this block is a part of, or boolean true if there is no specific experiment name.

description: This is the display title for your block, which can be translated with our translation functions. The block inserter will show this name.

description:
Blocks are grouped into categories to help users browse and discover them.
 Core provided categories are: text, media, design, widgets, theme, embed

Plugins and Themes can also register custom block categories.

https://developer.wordpress.org/block-editor/reference-guides/filters/block-filters/#managing-block-categories

enum: text media design widgets theme embed

description: Setting parent lets a block require that it is only available when nested within the specified blocks. For example, you might want to allow an ‘Add to Cart’ block to only be available within a ‘Product’ block.

description: The `ancestor` property makes a block available inside the specified block types at any position of the ancestor block subtree. That allows, for example, to place a ‘Comment Content’ block inside a ‘Column’ block, as long as ‘Column’ is somewhere within a ‘Comment Template’ block.

description: An icon property should be specified to make it easier to identify a block. These can be any of WordPress’ Dashicons (slug serving also as a fallback in non-js contexts).

description: This is a short description for your block, which can be translated with our translation functions. This will be shown in the block inspector.

description: Sometimes a block could have aliases that help users discover it while searching. For example, an image block could also want to be discovered by photo. You can do so by providing an array of unlimited terms (which are translated).

description: The current version number of the block, such as 1.0 or 1.0.3. It’s similar to how plugins are versioned. This field might be used with block assets to control cache invalidation, and when the block author omits it, then the installed version of WordPress is used instead.

description:
The gettext text domain of the plugin/block. More information can be found in the Text Domain section of the How to Internationalize your Plugin page.

https://developer.wordpress.org/plugins/internationalization/how-to-internationalize-your-plugin/

description:
Attributes provide the structured data needs of a block. They can exist in different forms when they are serialized, but they are declared together under a common interface.

See the attributes documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-attributes/ for more details.

description:
The type indicates the type of data that is stored by the attribute. It does not indicate where the data is stored, which is defined by the source field.

A type is required, unless an enum is provided. A type can be used with an enum.

Note that the validity of an object is determined by your source. For an example, see the query details below.

enum: null boolean object array string integer number

description: An attribute can be defined as one of a fixed set of values. This is specified by an enum, which contains an array of allowed values:

description: Attribute sources are used to define how the attribute values are extracted from saved post content. They provide a mechanism to map from the saved markup to a JavaScript representation of a block.

enum: attribute text html raw query meta

description:
The selector can be an HTML tag, or anything queryable with querySelector, such as a class or id attribute. Examples are given below.

For example, a selector of img will match an img element, and img.class will match an img element that has a class of class.

description:
Use an attribute source to extract the value from an attribute in the markup. The attribute is specified by the attribute field, which must be supplied.

Example: Extract the src attribute from an image found in the block’s markup.

description: Use the multiline property to extract the inner HTML of matching tag names for the use in RichText with the multiline prop.

description: Use query to extract an array of values from markup. Entries of the array are determined by the selector argument, where each matched element within the block will have an entry structured corresponding to the second argument, an object of attribute sources.

description:
Although attributes may be obtained from a post’s meta, meta attribute sources are considered deprecated; EntityProvider and related hook APIs should be used instead, as shown in the Create Meta Block how-to here:

https://developer.wordpress.org/block-editor/how-to-guides/metabox/#step-2-add-meta-block

description:
A block attribute can contain a default value, which will be used if the type and source do not match anything within the block content.

The value is provided by the default field, and the value should match the expected format of the attribute.

description:
Context provided for available access by descendants of blocks of this type, in the form of an object which maps a context name to one of the block’s own attribute.

See the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.

description:
Array of the names of context values to inherit from an ancestor provider.

See the block context documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-context/ for more details.

description: It contains as set of options to control features used in the editor. See the supports documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-supports/ for more details.

description: Anchors let you link directly to a specific block on a page. This property adds a field to define an id for the block and a button to copy the direct link.

description: This property adds block controls which allow to change block’s alignment.

enum: wide full left center right

description: This property allows to enable wide alignment for your theme. To disable this behavior for a single block, set this flag to false.

description: ARIA-labels let you define an accessible label for elements. This property allows enabling the definition of an aria-label for the block, without exposing a UI field.

description: Behaviors are a way to add additional functionality to a block. They are defined as an object with a name and a set of properties. Curently, only one behavior is supported: lightbox.

description: This property adds a 'lightbox' behavior to the block. It allows to open the block's content in a lightbox when clicking on it.

description: By default, the class .wp-block-your-block-name is added to the root element of your saved markup. This helps having a consistent mechanism for styling blocks that themes and plugins can rely on. If, for whatever reason, a class is not desired on the markup, this functionality can be disabled.

description:
This value signals that a block supports some of the properties related to color. When it does, the block editor will show UI controls for the user to set their values.

Note that the background and text keys have a default value of true, so if the color property is present they’ll also be considered enabled

description:
This property adds UI controls which allow the user to apply a solid background color to a block.

When color support is declared, this property is enabled by default (along with text), so simply setting color will enable background color.

To disable background support while keeping other color supports enabled, set to false.

When the block declares support for color.background, its attributes definition is extended to include two new attributes: backgroundColor and style

description:
This property adds UI controls which allow the user to apply a gradient background to a block.

Gradient presets are sourced from editor-gradient-presets theme support.

When the block declares support for color.gradient, its attributes definition is extended to include two new attributes: gradient and style

description:
This property adds block controls which allow the user to set link color in a block, link color is disabled by default.

Link color presets are sourced from the editor-color-palette theme support.

When the block declares support for color.link, its attributes definition is extended to include the style attribute

description:
This property adds block controls which allow the user to set text color in a block.

When color support is declared, this property is enabled by default (along with background), so simply setting color will enable text color.

Text color presets are sourced from the editor-color-palette theme support.

When the block declares support for color.text, its attributes definition is extended to include two new attributes: textColor and style

description:
Determines whether the contrast checker widget displays in the block editor UI.

The contrast checker appears only if the block declares support for color. It tests the readability of color combinations and warns if there is a potential issue. The property is enabled by default.

Set to `false` to explicitly disable.

description: This property adds a field to define a custom className for the block’s wrapper.

description: When the style picker is shown, a dropdown is displayed so the user can select a default style for this block type. If you prefer not to show the dropdown, set this property to false.

description:
This value signals that a block supports some of the CSS style properties related to dimensions. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific dimensions property, its attributes definition is extended to include the style attribute.

description: Allow blocks to define a minimum height value.

description:
This value signals that a block supports some of the properties related to filters. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific filter property, its attributes definition is extended to include the style attribute.

description: Allow blocks to define a duotone filter.

description: By default, a block’s markup can be edited individually. To disable this behavior, set html to false.

description: By default, all blocks will appear in the inserter, block transforms menu, Style Book, etc. To hide a block from all parts of the user interface so that it can only be inserted programmatically, set inserter to false.

description: This value only applies to blocks that are containers for inner blocks. If set to `true` the layout type will be `flow`. For other layout types it's necessary to set the `type` explicitly inside the `default` object.

description: Allows setting the `type` property to define what layout type is default for the block, and also default values for any properties inherent to that layout type, e.g., for a `flex` layout, a default value can be set for `flexWrap`.

description: The layout type.

enum: constrained grid flex

description: The content size used on all children.

description: The wide size used on alignwide children.

description: Content justification value.

enum: right center space-between left stretch

description: The orientation of the layout.

enum: horizontal vertical

description: The flex wrap value.

enum: wrap nowrap

description: The vertical alignment value.

enum: top center bottom space-between stretch

description: The minimum column width value.

description: The column count value.

description: Exposes a switcher control that allows toggling between all existing layout types.

description: Determines display of layout controls in the block sidebar. If set to false, layout controls will be hidden.

description: For the `flow` layout type only, determines display of the `Inner blocks use content width` toggle.

description: For the `flex` layout type only, determines display of sizing controls (Fit/Fill/Fixed) on all child blocks of the flex block.

description: For the `flex` layout type only, determines display of vertical alignment controls in the block toolbar.

description: For the `flex` layout type, determines display of justification controls in the block toolbar and block sidebar. For the `constrained` layout type, determines display of justification control in the block sidebar.

description: For the `flex` layout type only, determines display of the orientation control in the block toolbar.

description: A non-multiple block can be inserted into each post, one time only. For example, the built-in ‘More’ block cannot be inserted again if it already exists in the post being edited. A non-multiple block’s icon is automatically dimmed (unclickable) to prevent multiple instances.

description: A block may want to disable the ability of being converted into a reusable block. By default all blocks can be converted to a reusable block. If supports reusable is set to false, the option to convert the block into a reusable block will not appear.

description: A block may want to disable the ability to toggle the lock state. It can be locked/unlocked by a user from the block 'Options' dropdown by default. To disable this behavior, set lock to false.

description:
This value signals that a block supports some of the CSS style properties related to position. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific position property, its attributes definition is extended to include the style attribute.

description: Allow blocks to stick to their immediate parent when scrolling the page.

description:
This value signals that a block supports some of the CSS style properties related to spacing. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific spacing property, its attributes definition is extended to include the style attribute.

enum: top right left bottom

enum: vertical horizontal

description:
This value signals that a block supports some of the CSS style properties related to typography. When it does, the block editor will show UI controls for the user to set their values if the theme declares support.

When the block declares support for a specific typography property, its attributes definition is extended to include the style attribute.

description:
This value signals that a block supports the font-size CSS style property. When it does, the block editor will show an UI control for the user to set its value.

The values shown in this control are the ones declared by the theme via the editor-font-sizes theme support, or the default ones if none is provided.

When the block declares support for fontSize, its attributes definition is extended to include two new attributes: fontSize and style

description:
This value signals that a block supports the line-height CSS style property. When it does, the block editor will show an UI control for the user to set its value if the theme declares support.

When the block declares support for lineHeight, its attributes definition is extended to include a new attribute style of object type with no default assigned. It stores the custom value set by the user. The block can apply a default style by specifying its own style attribute with a default

description: Provides custom CSS selectors and mappings for the block. Selectors may be set for the block itself or per-feature e.g. typography. Custom selectors per feature or sub-feature, allow different block styles to be applied to different elements within the block.

description: The primary CSS class to apply to the block. This replaces the `.wp-block-name` class if set.

description: Custom CSS selector used to generate rules for the block's theme.json border styles.

description: Custom CSS selector used to generate rules for the block's theme.json color styles.

description: Custom CSS selector used to generate rules for the block's theme.json dimensions styles.

description: Custom CSS selector used to generate rules for the block's theme.json spacing styles.

description: Custom CSS selector used to generate rules for the block's theme.json typography styles.

description:
Block styles can be used to provide alternative styles to block. It works by adding a class name to the block’s wrapper. Using CSS, a theme developer can target the class name for the block style if it is selected.

Plugins and Themes can also register custom block style for existing blocks.

https://developer.wordpress.org/block-editor/reference-guides/block-api/block-styles

description:
It provides structured example data for the block. This data is used to construct a preview for the block to be shown in the Inspector Help Panel when the user mouses over the block.

See the example documentation at https://developer.wordpress.org/block-editor/reference-guides/block-api/block-registration/#example-optional for more details.

description: The viewportWidth controls the width of the iFrame container in which the block preview will get rendered

description: Set the attributes for the block example

description:
Set the inner blocks that should be used within the block example. The blocks should be defined as a nested array like this:

 [ [ 'core/heading', { content: 'This is an Example' }, [] ] ]

 Where each block itself is an array that contains the block name, the block attributes, and the blocks inner blocks.

description: Block type editor script definition. It will only be enqueued in the context of the editor.

description: Block type frontend and editor script definition. It will be enqueued both in the editor and when viewing the content on the front of the site.

description: Block type frontend script definition. It will be enqueued only when viewing the content on the front of the site.

description: Block type editor style definition. It will only be enqueued in the context of the editor.

description: Block type frontend style definition. It will be enqueued both in the editor and when viewing the content on the front of the site.

description: Block Variations is the API that allows a block to have similar versions of it, but all these versions share some common functionality.

description: The unique and machine-readable name.

description: A human-readable variation title.

description: A detailed variation description.

description: A category classification, used in search interfaces to arrange block types by category.

description: An icon helping to visualize the variation. It can have the same shape as the block type.

description: Indicates whether the current variation is the default one.

description: Values that override block attributes.

description: Initial configuration of nested blocks.

description: Example provides structured data for the block preview. You can set to undefined to disable the preview shown for the block type.

description: The list of scopes where the variation is applicable.

description: An array of terms (which can be translated) that help users discover the variation while searching.

description: The list of attributes that should be compared. Each attributes will be matched and the variation will be active if all of them are matching.

description: Template file loaded on the server when rendering a block.


title: Error-Pages config file schema

description: Error-Pages config file schema.

description: Templates list

description: Template properties

description: Path to the template file

description: Template name (optional, if path is defined)

description: Template content, if path is not defined

description: Responses, based on requested content-type format

description: JSON format

description: JSON response body (template tags are allowed here)

examples: {"error": true, "code": {{ code | json }}, "message": {{ message | json }}}

description: XML format

description: XML response body (template tags are allowed here)

examples: <?xml version="1.0" encoding="utf-8"?><error><code>{{ code }}</code><message>{{ message }}</message></error>

description: Error pages (codes)

description: Error page (code)

description: Error page message (title)

description: Error page description

examples: The server did not understand the request


bozr.json

description: Bozr test suite schema definition

description: Short name of the test that will be used in reports.

description: Long description of the test.

description: Ignore test due to a reason

enum: GET POST PUT DELETE HEAD OPTIONS PATCH CONNECT TRACE

enum: application/json application/xml text/xml text/csv

required: method url

required: on expect


secrethub.json

title: repository

description:
A repository of the current user
https://github.com/DannyBen/secret_hub#bulk-operations

title: secrets

description:
Secrets of the current repository
https://github.com/DannyBen/secret_hub#bulk-operations

description:
A secret of the current repository
https://github.com/DannyBen/secret_hub#bulk-operations

examples: SECRET PASSWORD

title: secret


title: Keycloak REST Api

description: This is a REST API reference for the Keycloak Admin

description:
/
Get accessible realms

Returns a list of accessible realms. The list is filtered based on what realms the caller is allowed to view.

briefRepresentation

in: query

description: Success

description:
/
Import a realm

Imports a realm from a full representation of that realm.  Realm name must be unique.

description: Success

description: /{realm}

description:
/
Get the top-level representation of the realm

It will not include nested information like User and Client representations.

description: Success

description:
/
Update the top-level information of the realm

Any user, roles or client information in the representation
will be ignored.  This will only update top-level attributes of the realm.

description: Success

description:
/
Delete the realm

/

description: Success

realm

in: path

description: realm name (not id!)

description:
/
Get admin events

Returns all admin events, or filters events based on URL query parameters listed here

authUser

description: user id

max

description: Maximum results size (defaults to 100)

description: Success

description:
/
Delete all admin events

/

description: Success

realm

description: realm name (not id!)

description:
/
Clear any user login failures for all users

This can release temporary disabled users

/

description: Success

description: realm name (not id!)

description:
/
Get status of a username in brute force detection

description: Success

description:
/
Clear any user login failures for the user

This can release temporary disabled user

description: Success

description: realm name (not id!)

description:
/
Get authenticator providers

Returns a stream of authenticator providers.
/

description: Success

description: realm name (not id!)

description:
/
Get client authenticator providers

Returns a stream of client authenticator providers.
/

description: Success

description: realm name (not id!)

description:
/
Create new authenticator configuration

description: Success

description: realm name (not id!)

description:
/
Get authenticator provider's configuration description
/

description: Success

description: realm name (not id!)

description:
/
Get authenticator configuration

description: Success

description:
/
Delete authenticator configuration

description: Success

description:
/
Update authenticator configuration

description: Success

description: realm name (not id!)

id

description: Configuration id

description:
/
Add new authentication execution

description: Success

realm

description: realm name (not id!)

description:
/
Get Single Execution
/

description: Success

description:
/
Delete execution

description: Success

description: realm name (not id!)

description:
/
Update execution with new configuration

description: Success

description: realm name (not id!)

executionId

description: Execution id

description:
/
Get execution's configuration

description: Success

realm

description: realm name (not id!)

executionId

description: Execution id

id

description: Configuration id

description:
/
Lower execution's priority

description: Success

realm

description: realm name (not id!)

executionId

description: Execution id

description:
/
Raise execution's priority

description: Success

realm

description: realm name (not id!)

executionId

description: Execution id

description:
/
Get authentication flows

Returns a stream of authentication flows.
/

description: Success

description:
/
Create a new authentication flow

description: Success

realm

description: realm name (not id!)

description:
/
Copy existing authentication flow under a new name

The new name is given as 'newName' attribute of the passed JSON object

description: Success

description: realm name (not id!)

flowAlias

description: Name of the existing authentication flow

description:
/
Get authentication executions for a flow

description: Success

description:
/
Update authentication executions of a Flow

description: Success

realm

description: realm name (not id!)

flowAlias

description: Flow alias

description:
/
Add new authentication execution to a flow

description: Success

realm

description: realm name (not id!)

flowAlias

description: Alias of parent flow

description:
/
Add new flow with new execution to existing flow

description: Success

realm

description: realm name (not id!)

flowAlias

description: Alias of parent authentication flow

description:
/
Get authentication flow for id

description: Success

description:
/
Update an authentication flow

description: Success

description:
/
Delete an authentication flow

description: Success

realm

description: realm name (not id!)

id

description: Flow id

description:
/
Get form action providers

Returns a stream of form action providers.
/

description: Success

realm

description: realm name (not id!)

description:
/
Get form providers

Returns a stream of form providers.
/

description: Success

description: realm name (not id!)

description:
/
Get configuration descriptions for all clients
/

description: Success

description: realm name (not id!)

description:
/
Register a new required actions

description: Success

description: realm name (not id!)

description:
/
Get required actions

Returns a stream of required actions.
/

description: Success

description: realm name (not id!)

description:
/
Get required action for alias

description: Success

description:
/
Update required action

description: Success

description:
/
Delete required action

description: Success

description: realm name (not id!)

alias

description: Alias of required action

description:
/
Lower required action's priority

description: Success

realm

description: realm name (not id!)

alias

description: Alias of required action

description:
/
Raise required action's priority

description: Success

realm

description: realm name (not id!)

alias

description: Alias of required action

description:
/
Get unregistered required actions

Returns a stream of unregistered required actions.
/

description: Success

realm

description: realm name (not id!)

description:
/
Base path for importing clients under this realm.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Base path for retrieve providers with the configProperties properly filled

description: Success

description: realm name (not id!)

description:
/
Get client scopes belonging to the realm

Returns a list of client scopes belonging to the realm
/

description: Success

description:
/
Create a new client scope

Client Scope's name must be unique!

description: Success

description: realm name (not id!)

description:
/
Update the client scope

description: Success

description:
/
Get representation of the client scope

description: Success

description:
/
Delete the client scope
/

description: Success

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Create multiple mappers

/

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Create a mapper

description: Success

description:
/
Get mappers

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get mappers by name for a specific protocol

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get all scope mappings for the client

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get the roles associated with a client's scope

Returns roles for the client.

description: Success

description:
/
Add client-level roles to the client's scope

description: Success

description:
/
Remove client-level roles from the client's scope.

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
The available client-level roles

Returns the roles for the client that can be associated with the client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get effective client roles

Returns the roles for the client that are associated with the client's scope.

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get realm-level roles associated with the client's scope

description: Success

description:
/
Add a set of realm-level roles to the client's scope

description: Success

description:
/
Remove a set of realm-level roles from the client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get realm-level roles that are available to attach to this client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get effective realm-level roles associated with the client's scope

What this does is recurse
any composite roles associated with the client's scope and adds the roles to this lists.  The method is really
to show a comprehensive total view of realm-level roles associated with the client.

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get mapper by id

description: Success

description:
/
Update the mapper

description: Success

description:
/
Delete the mapper

description: Success

realm

description: realm name (not id!)

description: id of client scope (not name)

description: Mapper id

description:
/
Get client session stats

Returns a JSON map.  The key is the client id, the value is the number of sessions that currently are active
with that client.  Only clients that actually have a session associated with them will be in this map.

description: Success

description: realm name (not id!)

description: Success

description:
/
Create a new client scope

Client Scope's name must be unique!

description: Success

description: realm name (not id!)

description:
/
Update the client scope

description: Success

description:
/
Get representation of the client scope

description: Success

description:
/
Delete the client scope
/

description: Success

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Create multiple mappers

/

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Create a mapper

description: Success

description:
/
Get mappers

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get mappers by name for a specific protocol

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get all scope mappings for the client

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get the roles associated with a client's scope

Returns roles for the client.

description: Success

description:
/
Add client-level roles to the client's scope

description: Success

description:
/
Remove client-level roles from the client's scope.

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get realm-level roles associated with the client's scope

description: Success

description:
/
Add a set of realm-level roles to the client's scope

description: Success

description:
/
Remove a set of realm-level roles from the client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get realm-level roles that are available to attach to this client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client scope (not name)

description:
/
Get mapper by id

description: Success

description:
/
Update the mapper

description: Success

description:
/
Delete the mapper

description: Success

realm

description: realm name (not id!)

description: id of client scope (not name)

description: Mapper id

description:
/
Get clients belonging to the realm.

If a client can't be retrieved from the storage due to a problem with the underlying storage,
it is silently removed from the returned list.
This ensures that concurrent modifications to the list don't prevent callers from retrieving this list.

clientId

description: filter by clientId

viewableOnly

description: filter clients that cannot be viewed in full by admin

search

description: whether this is a search query or a getClientById query

first

description: the first result

max

description: the max results to return

description: Success

description:
/
Create a new client

Client's client_id must be unique!

description: Success

realm

description: realm name (not id!)

description:
/
Create a new initial access token.

description: Success

description:
/
Base path for managing client initial access tokens

description: Success

description: realm name (not id!)

description:
/
Base path for managing client initial access tokens

description: Success

description: realm name (not id!)

description:
/
Update the client

description: Success

description:
/
Get representation of the client

description: Success

description:
/
Delete the client

/

description: Success

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get key info

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get a keystore file for the client, containing private key and public certificate

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Generate a new certificate with new key pair

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Generate a new keypair and certificate, and get the private key file

Generates a keypair and certificate and serves the private key in a specified keystore format.
Only generated public certificate is saved in Keycloak DB - the private key is not.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Upload certificate and eventually private key

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Upload only certificate, not private key

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Generate a new secret for the client

description: Success

description:
/
Get the client secret

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Invalidate the rotated secret for the client

description: Success

description:
/
Get the rotated client secret

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get default client scopes.  Only name and ids are returned.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Base path for managing a specific client.

description: Success

description:
/
Base path for managing a specific client.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Create JSON with payload of example access token

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Create JSON with payload of example id token

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Create JSON with payload of example user info

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Return list of all protocol mappers, which will be used when generating tokens issued for particular client. This means
protocol mappers assigned to this client directly and protocol mappers assigned to all client scopes of this client.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.

This contains scope mappings, which this client has directly, as well as scope mappings, which are granted to all client scopes,
which are linked with this client.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

roleContainerId

description: either realm name OR client UUID

description:
/
Get roles, which this client doesn't have scope for and can't have them in the accessToken issued for him. Defacto all the
other roles of particular role container, which are not in {

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

roleContainerId

description: either realm name OR client UUID

description:
/
Base path for managing a specific client.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Return object stating whether client Authorization permissions have been initialized or not and a reference

description: Success

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Register a cluster node with the client

Manually register cluster node to this client - usually it's not needed to call this directly as adapter should handle
by sending registration request to Keycloak

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Unregister a cluster node from the client

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get application offline session count

Returns a number of offline user sessions associated with this client

{
"count": number
}

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get offline sessions for client

Returns a list of offline user sessions associated with this client

first

description: Paging offset

max

description: Maximum results size (defaults to 100)

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get optional client scopes.  Only name and ids are returned.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Base path for managing a specific client.

description: Success

description:
/
Base path for managing a specific client.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Create multiple mappers

/

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Create a mapper

description: Success

description:
/
Get mappers

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get mappers by name for a specific protocol

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Push the client's revocation policy to its admin URL

If the client has an admin URL, push revocation policy to it.
/

description: Success

description: GlobalRequestResult

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Generate a new registration access token for the client

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get all roles for the realm or client

description: Success

description:
/
Create a new role for the realm or client

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get a role by name

description: Success

description:
/
Delete a role by name

description: Success

description:
/
Update a role by name

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: role's name (not id!)

description:
/
Add a composite to the role

description: Success

description:
/
Get composites of the role

description: Success

description:
/
Remove roles from the role's composite

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: role's name (not id!)

description:
/
Get client-level roles for the client that are in the role's composite

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: role's name (not id!)

description:
/
Get realm-level roles of the role's composite

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: role's name (not id!)

description:
/
Returns a stream of groups that have the specified role name

first

description: first result to return. Ignored if negative or {@code null}.

max

description: maximum number of results to return. Ignored if negative or {@code null}.

briefRepresentation

description: if false, return a full representation of the {@code GroupRepresentation} objects.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: the role name.

description:
/
Return object stating whether role Authorization permissions have been initialized or not and a reference

description: Success

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Returns a stream of users that have the specified role name.

first

description: first result to return. Ignored if negative or {@code null}.

max

description: maximum number of results to return. Ignored if negative or {@code null}.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

role-name

description: the role name.

description:
/
Get all scope mappings for the client

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get the roles associated with a client's scope

Returns roles for the client.

description: Success

description:
/
Add client-level roles to the client's scope

description: Success

description:
/
Remove client-level roles from the client's scope.

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get realm-level roles associated with the client's scope

description: Success

description:
/
Add a set of realm-level roles to the client's scope

description: Success

description:
/
Remove a set of realm-level roles from the client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get realm-level roles that are available to attach to this client's scope

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get a user dedicated to the service account

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get application session count

Returns a number of user sessions associated with this client

{
"count": number
}

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Test if registered cluster nodes are available

Tests availability by sending 'ping' request to all cluster nodes.

description: Success

description: GlobalRequestResult

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get user sessions for client

Returns a list of user sessions associated with this client

first

description: Paging offset

max

description: Maximum results size (defaults to 100)

description: Success

realm

description: realm name (not id!)

id

description: id of client (not client-id)

description:
/
Get mapper by id

description: Success

description:
/
Update the mapper

description: Success

description:
/
Delete the mapper

description: Success

realm

description: realm name (not id!)

description: id of client (not client-id)

description: Mapper id

description:
/
Base path for managing components under this realm.

description: Success

description:
/
Base path for managing components under this realm.

description: Success

description: realm name (not id!)

description:
/
Base path for managing components under this realm.

description: Success

description:
/
Base path for managing components under this realm.

description: Success

description:
/
Base path for managing components under this realm.

description: Success

description: realm name (not id!)

description:
/
List of subcomponent types that are available to configure for a particular parent component.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Get realm default client scopes.  Only name and ids are returned.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Get group hierarchy.  Only name and ids are returned.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Get realm optional client scopes.  Only name and ids are returned.

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Get events

Returns all events, or filters them based on URL query parameters listed here

type

description: The types of events to return

client

description: App or oauth client name

user

description: User id

dateFrom

description: From date

dateTo

description: To date

ipAddress

description: IP address

first

description: Paging offset

max

description: Maximum results size (defaults to 100)

description: Success

description:
/
Delete all events

/

description: Success

realm

description: realm name (not id!)

description:
/
Get the events provider configuration

Returns JSON object with events provider configuration

description: Success

description:
/
Update the events provider

Change the events provider and/or its configuration

description: Success

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Get group hierarchy.  Only name and ids are returned.

description: Success

description:
/
create or add a top level realm groupSet or create child.  This will update the group and set the parent if it exists.  Create it and set the parent
if the group doesn't exist.

description: Success

description: realm name (not id!)

description: Success

description:
/
Update group, ignores subgroups.

description: Success

description:
/
Does not expand hierarchy.  Subgroups will not be set.

description: Success

description: realm name (not id!)

description:
/
Set or create child.  This will just set the parent if it exists.  Create it and set the parent
if the group doesn't exist.

description: Success

description: realm name (not id!)

description: Success

description: Success

description: realm name (not id!)

description:
/
Get users

Returns a stream of users, filtered according to query parameters

first

description: Pagination offset

max

description: Maximum results size (defaults to 100)

briefRepresentation

description: Only return basic information (only guaranteed to return id, username, created, first and last name,

description: Success

realm

description: realm name (not id!)

description:
/
Get role mappings

description: Success

description: realm name (not id!)

description:
/
Get client-level role mappings for the user, and the app

description: Success

description:
/
Add client-level roles to the user role mapping

description: Success

description:
/
Delete client-level roles from user role mapping

description: Success

description: realm name (not id!)

description:
/
Get available client-level roles that can be mapped to the user

description: Success

description: realm name (not id!)

description:
/
Get effective client-level role mappings

This recurses any composite roles

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

description:
/
Get realm-level role mappings

description: Success

description:
/
Add realm-level role mappings to the user

description: Success

description:
/
Delete realm-level role mappings

description: Success

description: realm name (not id!)

description:
/
Get realm-level roles that can be mapped

description: Success

description: realm name (not id!)

description:
/
Get effective realm-level role mappings

This will recurse all composite roles to get the result.

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

description:
/
Returns the groups counts.

description: Success

description: realm name (not id!)

description:
/
Import identity provider from uploaded JSON file

description: Success

description: realm name (not id!)

description:
/
Get identity providers

description: Success

description:
/
Create a new identity provider

description: Success

description: realm name (not id!)

description:
/
Get the identity provider

description: Success

description:
/
Delete the identity provider

description: Success

description:
/
Update the identity provider

description: Success

description: realm name (not id!)

description:
/
Export public broker configuration for identity provider

format

description: Format to use

description: Success

realm

description: realm name (not id!)

description: Success

description: Success

description: realm name (not id!)

description:
/
Get mapper types for identity provider
/

description: Success

description: realm name (not id!)

description:
/
Get mappers for identity provider
/

description: Success

description:
/
Add a mapper to identity provider

description: Success

description: realm name (not id!)

description:
/
Get mapper by id for the identity provider

description: Success

description:
/
Update a mapper for the identity provider

description: Success

description:
/
Delete a mapper for the identity provider

description: Success

description: realm name (not id!)

description:
/
Get identity providers

description: Success

description: realm name (not id!)

description: Provider id

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Base path for managing localization under this realm.
/

description: Success

description: realm name (not id!)

description:
/
Import localization from uploaded JSON file
/

description: Success

description:
/
Base path for managing localization under this realm.
/

description: Success

description:
/
Base path for managing localization under this realm.
/

description: Success

description: realm name (not id!)

description:
/
Base path for managing localization under this realm.
/

description: Success

description:
/
Base path for managing localization under this realm.
/

description: Success

description:
/
Base path for managing localization under this realm.
/

description: Success

description: realm name (not id!)

description:
/
Removes all user sessions.  Any client that has an admin url will also be told to invalidate any sessions
they have.

/

description: Success

description: GlobalRequestResult

description: realm name (not id!)

description:
/
Partial export of existing realm into a JSON file.

description: Success

description: realm name (not id!)

description:
/
Partial import from a JSON file to an existing realm.

description: Success

description: realm name (not id!)

description:
/
Push the realm's revocation policy to any client that has an admin url associated with it.

/

description: Success

description: realm name (not id!)

description:
/
Get all roles for the realm or client

description: Success

description:
/
Create a new role for the realm or client

description: Success

description: realm name (not id!)

description:
/
Get a specific role's representation

description: Success

description:
/
Delete the role

description: Success

description:
/
Update the role

description: Success

description: realm name (not id!)

role-id

description: id of role

description:
/
Make the role a composite role by associating some child roles

description: Success

description:
/
Get role's children

Returns a set of role's children provided the role is a composite.

description: Success

description:
/
Remove a set of roles from the role's composite

description: Success

realm

description: realm name (not id!)

description:
/
Get client-level roles for the client that are in the role's composite

description: Success

description: realm name (not id!)

description:
/
Get realm-level roles that are in the role's composite

description: Success

description: realm name (not id!)

description:
/
Return object stating whether role Authoirzation permissions have been initialized or not and a reference

description: Success

description: Success

description: realm name (not id!)

description:
/
Get a role by name

description: Success

description:
/
Delete a role by name

description: Success

description:
/
Update a role by name

description: Success

description: realm name (not id!)

role-name

description: role's name (not id!)

description:
/
Add a composite to the role

description: Success

description:
/
Get composites of the role

description: Success

description:
/
Remove roles from the role's composite

description: Success

realm

description: realm name (not id!)

role-name

description: role's name (not id!)

description:
/
Get client-level roles for the client that are in the role's composite

description: Success

realm

description: realm name (not id!)

role-name

description: role's name (not id!)

description:
/
Get realm-level roles of the role's composite

description: Success

realm

description: realm name (not id!)

role-name

description: role's name (not id!)

description:
/
Returns a stream of groups that have the specified role name

first

description: first result to return. Ignored if negative or {@code null}.

max

description: maximum number of results to return. Ignored if negative or {@code null}.

briefRepresentation

description: if false, return a full representation of the {@code GroupRepresentation} objects.

description: Success

realm

description: realm name (not id!)

role-name

description: the role name.

description: Success

description: Success

realm

description: realm name (not id!)

description:
/
Returns a stream of users that have the specified role name.

first

description: first result to return. Ignored if negative or {@code null}.

max

description: maximum number of results to return. Ignored if negative or {@code null}.

description: Success

realm

description: realm name (not id!)

role-name

description: the role name.

description:
/
Remove a specific user session. Any client that has an admin url will also be told to invalidate this
particular session.

description: Success

realm

description: realm name (not id!)

description:
/
Test SMTP connection with current logged in user

description: Success

description: realm name (not id!)

description:
/
Create a new user

Username must be unique.

description: Success

description:
/
Get users

Returns a stream of users, filtered according to query parameters.

search

description: A String contained in username, first or last name, or email

lastName

description: A String contained in lastName, or the complete lastName, if param "exact" is true

firstName

description: A String contained in firstName, or the complete firstName, if param "exact" is true

email

description: A String contained in email, or the complete email, if param "exact" is true

username

description: A String contained in username, or the complete username, if param "exact" is true

emailVerified

description: whether the email has been verified

idpAlias

description: The alias of an Identity Provider linked to the user

idpUserId

description: The userId at an Identity Provider linked to the user

first

description: Pagination offset

max

description: Maximum results size (defaults to 100)

enabled

description: Boolean representing if user is enabled or not

briefRepresentation

description: Boolean which defines whether brief representations are returned (default: false)

exact

description: Boolean which defines whether the params "last", "first", "email" and "username" must match exactly

description: A query to search for custom attributes, in the format 'key1:value2 key2:value2'

description: Success

realm

description: realm name (not id!)

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description:
/
Base path for the admin REST API for one particular realm.

description: Success

description: realm name (not id!)

description:
/
Update the user

description: Success

description:
/
Get representation of the user

description: Success

description:
/
Delete the user
/

description: Success

description: realm name (not id!)

id

description: User id

description:
/
Return credential types, which are provided by the user storage where user is stored. Returned values can contain for example "password", "otp" etc.
This will always return empty list for "local" users, which are not backed by any user storage

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get consents granted by the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Revoke consent and offline tokens for particular client from user

description: Success

realm

description: realm name (not id!)

id

description: User id

client

description: Client id

description:
/
Get representation of the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Remove a credential for a user

/

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Move a credential to a position behind another credential

description: Success

realm

description: realm name (not id!)

id

description: User id

credentialId

description: The credential to move

newPreviousCredentialId

description: The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list.

description:
/
Move a credential to a first position in the credentials list of the user

description: Success

realm

description: realm name (not id!)

id

description: User id

credentialId

description: The credential to move

description:
/
Update a credential label for a user
/

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Disable all credentials for a user of a specific type

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Send a update account email to the user

An email contains a link the user can click to perform a set of required actions.
The redirectUri and clientId parameters are optional. If no redirect is given, then there will
be no link back to click after actions have completed.  Redirect uri must be a valid uri for the
particular clientId.

description: Redirect uri

description: Client id

lifespan

description: Number of seconds after which the generated token expires

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get social logins associated with the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Add a social login provider to the user

description: Success

description:
/
Remove a social login provider from user

description: Success

realm

description: realm name (not id!)

id

description: User id

provider

description: Social login provider id

description:
/
Get representation of the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get representation of the user

description: Success

description:
/
Get representation of the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get representation of the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Impersonate the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Remove all user sessions associated with the user

Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.

/

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get offline sessions associated with the user and client

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Set up a new password for the user.

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Send an email to the user with a link they can click to reset their password.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.

This endpoint has been deprecated.  Please use the execute-actions-email passing a list with
UPDATE_PASSWORD within it.

description: redirect uri

description: client id

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get role mappings

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get client-level role mappings for the user, and the app

description: Success

description:
/
Add client-level roles to the user role mapping

description: Success

description:
/
Delete client-level roles from user role mapping

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get available client-level roles that can be mapped to the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get effective client-level role mappings

This recurses any composite roles

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get realm-level role mappings

description: Success

description:
/
Add realm-level role mappings to the user

description: Success

description:
/
Delete realm-level role mappings

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get realm-level roles that can be mapped

description: Success

realm

description: realm name (not id!)

id

description: User id

briefRepresentation

description: if false, return roles with their attributes

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Send an email-verification email to the user

An email contains a link the user can click to verify their email address.
The redirectUri and clientId parameters are optional. The default for the
redirect is the account client.

description: Redirect uri

description: Client id

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Get sessions associated with the user

description: Success

realm

description: realm name (not id!)

id

description: User id

description:
/
Returns the number of users that match the given criteria.
It can be called in three different ways.
1. Don't specify any criteria and pass {

search

description: arbitrary search string for all the fields below

lastName

description: last name filter

firstName

description: first name filter

email

description: email filter

username

description: username filter

enabled

description: Boolean representing if user is enabled or not

description: Success

realm

description: realm name (not id!)

description:
/
Get representation of the user

description: Success

description:
/
Get representation of the user

description: Success

description: realm name (not id!)

description: ClientPolicyRepresentation

description: KeyUse

description: CapabilityType

enum: INTERNAL ACCESS ID ADMIN USERINFO LOGOUT AUTHORIZATION_RESPONSE

description: TokenCategory

description: ClaimValue

description: ClaimValue

description: TokenCategory

description: TokenCategory

description: TokenCategory

description: TokenCategory

description: TokenCategory

description: Policy

description: DecisionStrategy

description: Logic

description: PolicyEnforcementMode

description: DecisionStrategy


main.json

title: QuiltMC Mod Metadata (Version-agnostic)


tsd.json

description: Path to a '.d.ts' bundle file (see below). Change this if you want the bundle to be closer to the actual source files. TSD will create the appropriate relative paths.

description: A list of installed typings.

description: Path to the typings directory, the definitions will be installed in the appropriate sub-folders. Change this to have typings in your main code directory, but this is not recommended as the mixed styles used in the definitions it will confuse your inspections and lint-tools.

default: typings

description: Branch name or other git reference of the repository. Change this to use legacy branches.

default: master

description: GitHub user and repo name of the typings repository. Change this if you want to use TSD from a DefinitelyTyped fork.

default: borisyankov/DefinitelyTyped

description: Set to 'false' to disable the stats tracking. Keep in mind the stats are anonymous, help us improve TSD & DT and motivate us to spend our time on development.

description: Tracks config version for future changes (don't change this).

required: path ref repo version

title: JSON schema for DefinitelyTyped TypeScript definitions manager (TSD)


all.schema-store.json

title: JSON Schema documents for all AsyncAPI spec versions

description: All AsyncAPI JSON Schema documents listed in one file. Needed for serving all documents through schemastore.org


behat.json

title: Profile name

$ref: #/definitions/profile

title: Profile

title: How to format tests output

default: pretty

title: Prints the feature as is

title: Prints one character per step

title: Outputs the failures in JUnit compatible files.

title: Test suites

$ref: #/definitions/suite

title: Behat extensions

title: Test suite

title: Paths to execute

title: Suite contexts

type: string object

title: Suite filters

title: Default profile

title: JSON schema for Behat configuration files


prisma.json

description: A piece of code that you should run.

required: query webhook

description:
Type definitions for database models, relations, enums and other types
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

type: string array

description:
A secure secret for the current API endpoint
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

description:
Disable authentication for the current API endpoint
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

description:
How and where generate client
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

title: file

description: Files to be generated for the current API endpoint

description:
A client name
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

enum: javascript-client typescript-client flow-client go-client graphql-schema

description:
An output path
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

title: seed

description:
A database seed
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

description: Commands to run while seeding a service for the current API endpoint

description: Instructions to run while seeding a service for the current API endpoint

description:
Server-side subscriptions
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

$ref: #/definitions/subscription

title: fields

description:
Fields to use in variable interpolations via `${self:custom.field}`
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

title: hooks

description:
Hooks
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

description:
An endpoint the service will be reachable at
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

description:
A relational or document database
https://v1.prisma.io/docs/1.34/prisma-cli-and-configuration/prisma-yml-5cy7/#reference

enum: relational document

title: JSON schema for Prisma prisma.yml files


asconfig-schema.json

$ref: #/definitions/nonEmptyString

$ref: #/definitions/arrayOfNonEmptyStrings

enum: sign-extension mutable-globals nontrapping-f2i bulk-memory simd threads exception-handling tail-calls reference-types multi-value gc memory64

description: Optimizes the module.

description: How much to focus on optimizing code.

description: How much to focus on shrinking code size.

description: Re-optimizes until no further improvements can be made.

description: Specifies the base directory of input and output files.

description: Specifies the WebAssembly output file (.wasm).

description: Specifies the WebAssembly text output file (.wat).

description: Specified the bindings to generate.

enum: esm raw

description: Enables source map generation. Optionally takes the URL.

description: Specifies the runtime variant to include in the program.

enum: incremental minimal stub

description: Disallows the use of unsafe features in user code.

description: Enables debug information in emitted binaries.

description: Replaces assertions with just their value without trapping.

description: Performs compilation as usual but does not emit code.

description: Imports the memory provided as 'env.memory'.

description: Does not export the memory as 'memory'.

description: Sets the initial memory size in pages.

description: Sets the maximum memory size in pages.

description: Declare memory as shared. Requires maximumMemory.

description: Assume that imported memory is zero filled. Requires importMemory.

description: Sets the start offset of compiler-generated static memory.

description: Imports the function table provided as 'env.table'.

description: Exports the function table as 'table'.

description: Exports the start function instead of calling it implicitly.

description: Adds one or multiple paths to custom library components.

description: Adds one or multiple paths to package resolution.

description: Aliases a global object under another name.

description: Sets the trap mode to use.

enum: allow clamp js

description: Specifies additional Binaryen passes to run.

description: Skips validating the module using Binaryen.

description: Enables WebAssembly features that are disabled by default.

$ref: #/definitions/webAssemblyFeatures

description: Disables WebAssembly features that are enabled by default.

description: Specifies the path to a custom transform to 'require'.

description: Make yourself sad for no good reason.

description: Prints measuring information on I/O and compile times.

description: Disables terminal colors.

description: Exports the runtime helpers (__new, __collect etc.).

description: Enforces very low (<64k) memory constraints.

description: Sets the start offset of emitted table elements.

description: Uses the specified Wasm binary of the compiler.

$ref: #/definitions/compilerOptions

title: JSON schema for asconfig.json


description: The URI of the JSON schema corresponding to the version of the external property file format.

format: uri

description: The SARIF format version of this external properties object.

description: A stable, unique identifier for this external properties object, in the form of a GUID.

description: A stable, unique identifier for the run associated with this external properties object, in the form of a GUID.

description: A conversion object that will be merged with an external run.

description: An array of graph objects that will merged with an external run.

description: Key/value pairs that provide additional information that will be merged with an external run.

description: An array of artifact objects that will be merged with an external run.

description: Describes the invocation of the analysis tool that will be merged with an external run.

description: An array of logical locations such as namespaces, types or functions that will be merged with an external run.

description: An array of threadFlowLocation objects that will be merged with an external run.

description: An array of result objects that will be merged with an external run.

description: Tool taxonomies that will be merged with an external run.

description: The analysis tool object that will be merged with an external run.

description: Tool extensions that will be merged with an external run.

description: Tool policies that will be merged with an external run.

description: Tool translations that will be merged with an external run.

description: Addresses that will be merged with with an external run.

description: Requests that will be merged with an external run.

description: Responses that will be merged with an external run.

description: Key/value pairs that provide additional information about the external properties.

title: SARIF External Property File Schema Version 2.1.0-rtm.2 JSON Schema