Boundary Controller HTTP API

Auth Method Service

List Auth MethodsGET/v1/auth-methods

Lists all Auth Methods.

Query Parameters

scope_id string

recursive boolean

filter string

Successful Response

items object[]

AuthMethod contains all fields related to an Auth Method resource

id string

Output only. The ID of the Auth Method.

scope_id string

The ID of the Scope of which this Auth Method is a part.

scope object

Output only. Scope information for this Auth method.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

is_primary boolean

Output only. Whether this auth method is the primary auth method for it's scope. To change this value update the primary_auth_method_id field on the scope.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Create Auth MethodPOST/v1/auth-methods

Creates a single Auth Method.

Body Parameters

scope_id string

The ID of the Scope of which this Auth Method is a part.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

Successful Response

id string

Output only. The ID of the Auth Method.

scope_id string

The ID of the Scope of which this Auth Method is a part.

scope object

Output only. Scope information for this Auth method.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

is_primary boolean

Output only. Whether this auth method is the primary auth method for it's scope. To change this value update the primary_auth_method_id field on the scope.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

AuthenticatePOST/v1/auth-methods/{auth_method_id}:authenticate

Authenticate a user to an scope and retrieve an authentication token.

Path Parameters

auth_method_id string

The ID of the Auth Method in the system that should be used for authentication.

Body Parameters

token_type string

This can be "cookie" or "token". If not provided, "token" will be used. "cookie" activates a split-cookie method where the token is split partially between http-only and regular cookies in order to keep it safe from rogue JS in the browser. Deprecated, use "type" instead.

type string

attributes object

Attributes are passed to the Auth Method; the valid keys and values depend on the type of Auth Method as well as the command.

command string

The command to perform.

Get Auth MethodGET/v1/auth-methods/{id}

Gets a single Auth Method.

Path Parameters

id string

Successful Response

id string

Output only. The ID of the Auth Method.

scope_id string

The ID of the Scope of which this Auth Method is a part.

scope object

Output only. Scope information for this Auth method.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

is_primary boolean

Output only. Whether this auth method is the primary auth method for it's scope. To change this value update the primary_auth_method_id field on the scope.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Delete Auth MethodDELETE/v1/auth-methods/{id}

Deletes an AuthMethod

Path Parameters

id string

Update Auth MethodPATCH/v1/auth-methods/{id}

Updates an Auth Method.

Path Parameters

id string

Body Parameters

scope_id string

The ID of the Scope of which this Auth Method is a part.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

Successful Response

id string

Output only. The ID of the Auth Method.

scope_id string

The ID of the Scope of which this Auth Method is a part.

scope object

Output only. Scope information for this Auth method.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

is_primary boolean

Output only. Whether this auth method is the primary auth method for it's scope. To change this value update the primary_auth_method_id field on the scope.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.

Change StatePOST/v1/auth-methods/{id}:change-state

Changes the state of an OIDC AuthMethod

Path Parameters

id string

Body Parameters

version integer

Version is used to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

attributes object

The attributes specific to this auth method's state.

Successful Response

id string

Output only. The ID of the Auth Method.

scope_id string

The ID of the Scope of which this Auth Method is a part.

scope object

Output only. Scope information for this Auth method.

id string

Output only. The ID of the Scope.

type string

Output only. The type of the Scope.

name string

Output only. The name of the Scope, if any.

description string

Output only. The description of the Scope, if any.

parent_scope_id string

Output only. The ID of the parent Scope, if any. This field will be empty if this is the "global" scope.

name string

Optional name for identification purposes.

description string

Optional user-set description for identification purposes.

created_time string

Output only. The time this resource was created.

updated_time string

Output only. The time this resource was last updated.

version integer

Version is used in mutation requests, after the initial creation, to ensure this resource has not changed. The mutation will fail if the version does not match the latest known good version.

type string

The Auth Method type.

attributes object

The attributes that are applicable for the specific Auth Method type.

is_primary boolean

Output only. Whether this auth method is the primary auth method for it's scope. To change this value update the primary_auth_method_id field on the scope.

authorized_actions string[]

authorized_collection_actions object

Output only. The authorized actions for the scope's collections.