df35699c4e
* Fix down migrations * Udpates due to merge * Sentinel values only have to be greater than 0 * Create credential related sdk structs and methods. * Post merge interface updating. * Removing scratch code that was not cleaned up. * updates * Convert client certificate and client certificate keys into pem blocks and validate. * Add newline at end of file. * Faster check for "s" at the end of a resource name when generating from templates. * make fmt * updates * Add dynamic credentials to a session * Refactor: move contents of file * updates * Updates * Add InvalidDynamicCredential error * Assign credentials * Allow updating client certificates seperate from the client certificate key. * Replace application purpose string with enum value * PR feedback / fix go test . * Delete dead code * Use common view * Refactor: extract interface and rename method * Refactor: move code to eliminate privPurpLibrary * Add comment to requestMap * Refactor: do not export methods on an unexported struct * Update internal/db/schema/migrations/postgres/10/03_vault_credential.up.sql Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com> * Add comments to credential Purpose constants * Reorder switch statements to handle errors first * PR feedback * update * fix merge * Organizing the scheduler code and extract the individual store creation test helper function. * Run 'make fmt' * Create certificate when creating store. Allow vault address to be passed in as option * Refactor: rename database views and associated structs This change renames two database views and associated go structs to use a consistent naming pattern. Views ending in 'private' contain encrypted credentials needed for connecting to Vault. Views ending in 'public' mirror the 'private' views but do not include any encrypted values. This change does not include any changes to functionality or behavior. * Adding SAD target operations for credential libraries to the SDK. * Add status field and enumeration table for credential status * Refactor: rename Status to TokenStatus * Add status to vault credentials * Creating the template for the CLI and helper functions. * Add private database view for vault credentials * Add scope_id to view and cleanup TODO comment * Reformat embedded sql queries * Add vault client helpers * updates * white space * Add LookupLease test * CLI commands for Store work. Renamed fields in proto w/ vault prefix. * Test issue credentials with client TLS * Add additional checks to vault ping * Add an error for vault token capabilities and create a VaultToken error kind * Add support for working with Vault policies * Use Vault 1.7.2 for testing * Add testing helper for creating a vault client with a non-root token * Fix Vault renew lease test The Vault renew lease endpoint accepts an optional duration parameter for requesting the number of seconds to extend the lease by. However, Vault is not required to honor this request. * Add a var for the required capabilities of a boundary Vault token * Enhance the test helper for adding a policy to Vault * Allow the test role in postgresql to revoke credentials * Remove out of date comments * Enhance Vault test helpers for the database secrets engine * Reformat comments * Add a method for getting the capabilities of the current Vault token * Add revoke lease to internal Vault client * Reformat: combine err return line with check for nil line * Remove redundant checks in test code Remove checks in test code that are redundant with checks in the test harness. * Refactor CreateToken test helper to return the secret and the token * Fix build failures caused by signature change in vault.CreateToken * Fix Vault version and Vault API link in comments * ran `make gen` after merging from mgaffney-vault. * Remove Vault prefix from attribute fields in API, create a base CLI option for adding field prefixes. format now uses that prefix for error reporting. * Template now allows attaching attribute field prefixes. * Credential store uses PrefixAttributeFieldErrorsWithSubactionPrefix. * Fixing naming of vault flags and helper flags. * Updating more references to generated api methods. * Make the capabilities String method more readable * Add comment outlining PrintApiError usage of Options. * Refactor test to move declarations closer to first use * Fix comment * Implement revoke method on vault repository * Tests now verify certs, CA, and tokens, addresses can be updated in a store. * Added test for creating store with pk/cert in same field. * Allo updating certificates seperate from private key. Only contact backing vault service when updating token. * Fixing bad tests and removing unused code. * Adding tests for various ways of updating tokens. * Add private credential * Add token revocation job and cred renewal/revocation job * Regen after merge. * Fixing field mask related merge error. * Create Library CLI. Removes vault prefix from path. Adds a WithoutCleanup testOption for vault. * Set all credentials to revoked when a token is revoked * Fixing missed renaming update. * fix copy/paste error. * Fixing code generation errors after merge. * make gen after merge. * Update internal/cmd/commands/credentialstorescmd/vault_funcs.go Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com> * Update internal/cmd/commands/credentialstorescmd/vault_funcs.go Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com> * Update internal/cmd/commands/credentialstorescmd/vault_funcs.go Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com> * Refactor: move migrations from 10 to 12 * Removing logic from transaction. * wrapping client errors in the calling op for CredentialStore's client() method. * Redact token * redact client key * updates * Add trigger to revoke credentials when session is canceled or terminated * Fixing some help text for some flags. * Add ability to load values from files (file://) or environment variables (env://). * Updating comments * fix bad merge * feedback * Adding issued credentials to sessions. * Error on capabilities * updates * Expose NewVaulTestServer * Add godoc * Adding generated SessionCredential struct for API. * Progress on building handler test for Authorize Session. * feedback * Update policies * Add 'revoke' as a status for Vault Tokens * Add delete_time to vault credential store * Create dynamic credentials at session creation time. * Tests pass with credentials attached to AuthorizedSession result. * Only call issue if there are credentials to issue. * Fixing output only issues. Adding type to credential library. * Fix test to clear un/pw generated. confirm generated un/pw changes from 1 authorize session call to another. * Update lookupTokenError * Add delete_time to private credential store * Refactor: move private store to separate file * Fixing tests for AuthorizeSession and verifying error cases. * Only create the credential repo if there are credentials to issue. * Rename Library field to CredentialLibrary. * Fixing missing change of Library to CredentialLibrary. * Removing Default SDK functions for fields which are required and update CLI to match. * Replace resource specific id variables with "id" and the input parmater for paths to be just a single string and the resource name as it should show up in the path. * Soft delete vault credential stores * Prevent new SQL functions from silently overwriting existing functions * Rename "Hmac" to "HMAC" in the human readable cli response table. * Fix tests * Add vault database cleanup jobs * Add ability to set the token period in the vault test harness * updates * Add not_null_columns func test * remove unused struct * Up no output timeout * Validate current vault token on addr update * Fix client cert change test * add cert test * Update revocation job where * Fix comment * Use Vault's default port in CLI help strings * Remove down migrations * Increase migration file numbers by 1 * Run make migrations * Move migrations from 12 to 10 * Increase Circle CI timeout for acceptance tests * Fix spelling mistake in error messages * ASD cmds for Target and returning credentials to AuthSession request (#1338) * Add Add/Set/Remove commands for libraries on Targets. Return credentials on AuthorizeSession request. Co-authored-by: Michael Gaffney <mgaffney@users.noreply.github.com> Co-authored-by: Louis Ruch <louisruch@gmail.com> Co-authored-by: Todd Knight <T.Alan.Knight@gmail.com> Co-authored-by: Jeff Mitchell <jeffrey.mitchell@gmail.com>
5865 lines
170 KiB
JSON
5865 lines
170 KiB
JSON
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Boundary Controller HTTP API",
|
|
"version": "version not set"
|
|
},
|
|
"tags": [
|
|
{
|
|
"name": "ScopeService"
|
|
},
|
|
{
|
|
"name": "AccountService"
|
|
},
|
|
{
|
|
"name": "AuthMethodService"
|
|
},
|
|
{
|
|
"name": "AuthTokenService"
|
|
},
|
|
{
|
|
"name": "CredentialLibraryService"
|
|
},
|
|
{
|
|
"name": "CredentialStoreService"
|
|
},
|
|
{
|
|
"name": "GroupService"
|
|
},
|
|
{
|
|
"name": "HostCatalogService"
|
|
},
|
|
{
|
|
"name": "HostService"
|
|
},
|
|
{
|
|
"name": "HostSetService"
|
|
},
|
|
{
|
|
"name": "ManagedGroupService"
|
|
},
|
|
{
|
|
"name": "RoleService"
|
|
},
|
|
{
|
|
"name": "SessionService"
|
|
},
|
|
{
|
|
"name": "TargetService"
|
|
},
|
|
{
|
|
"name": "UserService"
|
|
}
|
|
],
|
|
"schemes": [
|
|
"https",
|
|
"http"
|
|
],
|
|
"consumes": [
|
|
"application/json"
|
|
],
|
|
"produces": [
|
|
"application/json"
|
|
],
|
|
"paths": {
|
|
"/v1/accounts": {
|
|
"get": {
|
|
"summary": "Lists all Accounts in a specific Auth Method.",
|
|
"operationId": "AccountService_ListAccounts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListAccountsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "auth_method_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Account in the provided Auth Method.",
|
|
"operationId": "AccountService_CreateAccount",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/accounts/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Account.",
|
|
"operationId": "AccountService_GetAccount",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes an Account.",
|
|
"operationId": "AccountService_DeleteAccount",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteAccountResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates an Account.",
|
|
"operationId": "AccountService_UpdateAccount",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/accounts/{id}:change-password": {
|
|
"post": {
|
|
"summary": "Sets the password for the provided Account.",
|
|
"operationId": "AccountService_ChangePassword",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ChangePasswordRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/accounts/{id}:set-password": {
|
|
"post": {
|
|
"summary": "Sets the password for the provided Account.",
|
|
"operationId": "AccountService_SetPassword",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetPasswordRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AccountService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods": {
|
|
"get": {
|
|
"summary": "Lists all Auth Methods.",
|
|
"operationId": "AuthMethodService_ListAuthMethods",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListAuthMethodsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Auth Method.",
|
|
"operationId": "AuthMethodService_CreateAuthMethod",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods/{auth_method_id}:authenticate": {
|
|
"post": {
|
|
"summary": "Authenticate a user to an scope and retrieve an authentication token.",
|
|
"operationId": "AuthMethodService_Authenticate",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AuthenticateResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "auth_method_id",
|
|
"description": "The ID of the Auth Method in the system that should be used for authentication.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AuthenticateRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods/{auth_method_id}:authenticate:login": {
|
|
"post": {
|
|
"summary": "Deprecated: Use Authenticate instead",
|
|
"operationId": "AuthMethodService_AuthenticateLogin",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "auth_method_id",
|
|
"description": "The ID of the Auth Method in the system that should be used for authentication.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AuthenticateLoginRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Auth Method.",
|
|
"operationId": "AuthMethodService_GetAuthMethod",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes an AuthMethod",
|
|
"operationId": "AuthMethodService_DeleteAuthMethod",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteAuthMethodResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates an Auth Method.",
|
|
"operationId": "AuthMethodService_UpdateAuthMethod",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods/{id}:change-state": {
|
|
"post": {
|
|
"summary": "Changes the state of an OIDC AuthMethod",
|
|
"operationId": "AuthMethodService_ChangeState",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ChangeStateRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-tokens": {
|
|
"get": {
|
|
"summary": "Lists all Auth Tokens.",
|
|
"operationId": "AuthTokenService_ListAuthTokens",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListAuthTokensResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthTokenService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-tokens/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Auth Token.",
|
|
"operationId": "AuthTokenService_GetAuthToken",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthTokenService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes an Auth Token.",
|
|
"operationId": "AuthTokenService_DeleteAuthToken",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteAuthTokenResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthTokenService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/credential-libraries": {
|
|
"get": {
|
|
"summary": "Lists all Credential Library.",
|
|
"operationId": "CredentialLibraryService_ListCredentialLibraries",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListCredentialLibrariesResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "credential_store_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialLibraryService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Credential Library.",
|
|
"operationId": "CredentialLibraryService_CreateCredentialLibrary",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialLibraryService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/credential-libraries/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Credential Library.",
|
|
"operationId": "CredentialLibraryService_GetCredentialLibrary",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialLibraryService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Credential Library",
|
|
"operationId": "CredentialLibraryService_DeleteCredentialLibrary",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteCredentialLibraryResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialLibraryService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Credential Library.",
|
|
"operationId": "CredentialLibraryService_UpdateCredentialLibrary",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialLibraryService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/credential-stores": {
|
|
"get": {
|
|
"summary": "Lists all Credential Stores.",
|
|
"operationId": "CredentialStoreService_ListCredentialStores",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListCredentialStoresResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialStoreService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Credential Store.",
|
|
"operationId": "CredentialStoreService_CreateCredentialStore",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialStoreService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/credential-stores/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Credential Store.",
|
|
"operationId": "CredentialStoreService_GetCredentialStore",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialStoreService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a CredentialStore",
|
|
"operationId": "CredentialStoreService_DeleteCredentialStore",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteCredentialStoreResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialStoreService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Credential Store.",
|
|
"operationId": "CredentialStoreService_UpdateCredentialStore",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.CredentialStoreService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups": {
|
|
"get": {
|
|
"summary": "Lists all Groups.",
|
|
"operationId": "GroupService_ListGroups",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListGroupsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Group.",
|
|
"operationId": "GroupService_CreateGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Group.",
|
|
"operationId": "GroupService_GetGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Group.",
|
|
"operationId": "GroupService_DeleteGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteGroupResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Group.",
|
|
"operationId": "GroupService_UpdateGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups/{id}:add-members": {
|
|
"post": {
|
|
"summary": "Adds members to a Group.",
|
|
"operationId": "GroupService_AddGroupMembers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddGroupMembersRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups/{id}:remove-members": {
|
|
"post": {
|
|
"summary": "Removes the specified members from a Group.",
|
|
"operationId": "GroupService_RemoveGroupMembers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveGroupMembersRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups/{id}:set-members": {
|
|
"post": {
|
|
"summary": "Set a Group's members to exactly the list of provided in the request, removing any members that are not specified.",
|
|
"operationId": "GroupService_SetGroupMembers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetGroupMembersRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-catalogs": {
|
|
"get": {
|
|
"summary": "Gets a list of Host Catalogs.",
|
|
"operationId": "HostCatalogService_ListHostCatalogs",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListHostCatalogsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a Host Catalog",
|
|
"operationId": "HostCatalogService_CreateHostCatalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-catalogs/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Host Catalog.",
|
|
"operationId": "HostCatalogService_GetHostCatalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Host Catalog",
|
|
"operationId": "HostCatalogService_DeleteHostCatalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteHostCatalogResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Host Catalog",
|
|
"operationId": "HostCatalogService_UpdateHostCatalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets": {
|
|
"get": {
|
|
"summary": "List all Host Sets under the specific Catalog.",
|
|
"operationId": "HostSetService_ListHostSets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListHostSetsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "host_catalog_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a Host Set.",
|
|
"operationId": "HostSetService_CreateHostSet",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets/{id}": {
|
|
"get": {
|
|
"summary": "Get a single Host Set.",
|
|
"operationId": "HostSetService_GetHostSet",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Host Set.",
|
|
"operationId": "HostSetService_DeleteHostSet",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteHostSetResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Host Set.",
|
|
"operationId": "HostSetService_UpdateHostSet",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets/{id}:add-hosts": {
|
|
"post": {
|
|
"summary": "Adds existing Hosts to a Host Set.",
|
|
"operationId": "HostSetService_AddHostSetHosts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddHostSetHostsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets/{id}:remove-hosts": {
|
|
"post": {
|
|
"summary": "Removes Hosts from the Host Set.",
|
|
"operationId": "HostSetService_RemoveHostSetHosts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveHostSetHostsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets/{id}:set-hosts": {
|
|
"post": {
|
|
"summary": "Sets the Hosts on the Host Set.",
|
|
"operationId": "HostSetService_SetHostSetHosts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetHostSetHostsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/hosts": {
|
|
"get": {
|
|
"summary": "List all Hosts for the specified Catalog.",
|
|
"operationId": "HostService_ListHosts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListHostsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "host_catalog_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a single Host.",
|
|
"operationId": "HostService_CreateHost",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/hosts/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Host.",
|
|
"operationId": "HostService_GetHost",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a Host.",
|
|
"operationId": "HostService_DeleteHost",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteHostResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Update a Host.",
|
|
"operationId": "HostService_UpdateHost",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/managed-groups": {
|
|
"get": {
|
|
"summary": "Lists all ManagedGroups in a specific Auth Method.",
|
|
"operationId": "ManagedGroupService_ListManagedGroups",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListManagedGroupsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "auth_method_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ManagedGroupService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single ManagedGroup in the provided Auth Method.",
|
|
"operationId": "ManagedGroupService_CreateManagedGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ManagedGroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/managed-groups/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single ManagedGroup.",
|
|
"operationId": "ManagedGroupService_GetManagedGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ManagedGroupService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a ManagedGroup.",
|
|
"operationId": "ManagedGroupService_DeleteManagedGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteManagedGroupResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ManagedGroupService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a ManagedGroup.",
|
|
"operationId": "ManagedGroupService_UpdateManagedGroup",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ManagedGroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles": {
|
|
"get": {
|
|
"summary": "Lists all Roles.",
|
|
"operationId": "RoleService_ListRoles",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListRolesResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Role.",
|
|
"operationId": "RoleService_CreateRole",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Role.",
|
|
"operationId": "RoleService_GetRole",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Role.",
|
|
"operationId": "RoleService_DeleteRole",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteRoleResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Role.",
|
|
"operationId": "RoleService_UpdateRole",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:add-grants": {
|
|
"post": {
|
|
"summary": "Adds grants to a Role",
|
|
"operationId": "RoleService_AddRoleGrants",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddRoleGrantsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:add-principals": {
|
|
"post": {
|
|
"summary": "Adds Users and/or Groups to a Role.",
|
|
"operationId": "RoleService_AddRolePrincipals",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddRolePrincipalsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:remove-grants": {
|
|
"post": {
|
|
"summary": "Removes grants from a Role.",
|
|
"operationId": "RoleService_RemoveRoleGrants",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveRoleGrantsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:remove-principals": {
|
|
"post": {
|
|
"summary": "Removes the specified Users and/or Groups from a Role.",
|
|
"operationId": "RoleService_RemoveRolePrincipals",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveRolePrincipalsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:set-grants": {
|
|
"post": {
|
|
"summary": "Set grants for a Role, removing any grants that are not specified in the request.",
|
|
"operationId": "RoleService_SetRoleGrants",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetRoleGrantsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/roles/{id}:set-principals": {
|
|
"post": {
|
|
"summary": "Set Users and/or Groups to a Role, removing any principals that are not specified in the request.",
|
|
"operationId": "RoleService_SetRolePrincipals",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetRolePrincipalsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.RoleService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/scopes": {
|
|
"get": {
|
|
"summary": "Lists all Scopes within the Scope provided in the request.",
|
|
"operationId": "ScopeService_ListScopes",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListScopesResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ScopeService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Scope.",
|
|
"operationId": "ScopeService_CreateScope",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
},
|
|
{
|
|
"name": "skip_admin_role_creation",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "skip_default_role_creation",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ScopeService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/scopes/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Scope.",
|
|
"operationId": "ScopeService_GetScope",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ScopeService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Scope.",
|
|
"operationId": "ScopeService_DeleteScope",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteScopeResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ScopeService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Scope.",
|
|
"operationId": "ScopeService_UpdateScope",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.ScopeService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/sessions": {
|
|
"get": {
|
|
"summary": "Lists all Sessions.",
|
|
"operationId": "SessionService_ListSessions",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListSessionsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.SessionService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/sessions/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Session.",
|
|
"operationId": "SessionService_GetSession",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.Session"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.SessionService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/sessions/{id}:cancel": {
|
|
"post": {
|
|
"summary": "Cancels a Session.",
|
|
"operationId": "SessionService_CancelSession",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.Session"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.CancelSessionRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.SessionService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets": {
|
|
"get": {
|
|
"summary": "Lists all Targets.",
|
|
"operationId": "TargetService_ListTargets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListTargetsResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single Target.",
|
|
"operationId": "TargetService_CreateTarget",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single Target.",
|
|
"operationId": "TargetService_GetTarget",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a Target.",
|
|
"operationId": "TargetService_DeleteTarget",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteTargetResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a Target.",
|
|
"operationId": "TargetService_UpdateTarget",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:add-credential-libraries": {
|
|
"post": {
|
|
"summary": "Adds existing Credential Libraries to a Target.",
|
|
"operationId": "TargetService_AddTargetCredentialLibraries",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddTargetCredentialLibrariesRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:add-host-sets": {
|
|
"post": {
|
|
"summary": "Adds existing Host Sets to a Target.",
|
|
"operationId": "TargetService_AddTargetHostSets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddTargetHostSetsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:authorize-session": {
|
|
"post": {
|
|
"summary": "Authorizes a Session.",
|
|
"operationId": "TargetService_AuthorizeSession",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.SessionAuthorization"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"description": "The ID of the target. Required unless some combination of scope_id/scope_name and name are set.",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AuthorizeSessionRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:remove-credential-libraries": {
|
|
"post": {
|
|
"summary": "Removes Credential Libraries from the Target.",
|
|
"operationId": "TargetService_RemoveTargetCredentialLibraries",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveTargetCredentialLibrariesRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:remove-host-sets": {
|
|
"post": {
|
|
"summary": "Removes Host Sets from the Target.",
|
|
"operationId": "TargetService_RemoveTargetHostSets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveTargetHostSetsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:set-credential-libraries": {
|
|
"post": {
|
|
"summary": "Sets the Credential Libraries on the Target.",
|
|
"operationId": "TargetService_SetTargetCredentialLibraries",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetTargetCredentialLibrariesRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/targets/{id}:set-host-sets": {
|
|
"post": {
|
|
"summary": "Sets the Host Sets on the Target.",
|
|
"operationId": "TargetService_SetTargetHostSets",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetTargetHostSetsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.TargetService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/users": {
|
|
"get": {
|
|
"summary": "Lists all Users.",
|
|
"operationId": "UserService_ListUsers",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.ListUsersResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "scope_id",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "recursive",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean"
|
|
},
|
|
{
|
|
"name": "filter",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single User.",
|
|
"operationId": "UserService_CreateUser",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/users/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single User.",
|
|
"operationId": "UserService_GetUser",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a User.",
|
|
"operationId": "UserService_DeleteUser",
|
|
"responses": {
|
|
"200": {
|
|
"description": "A successful response.",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.DeleteUserResponse"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
},
|
|
"patch": {
|
|
"summary": "Updates a User.",
|
|
"operationId": "UserService_UpdateUser",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
},
|
|
{
|
|
"name": "update_mask",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/users/{id}:add-accounts": {
|
|
"post": {
|
|
"summary": "Associates an Account to a User.",
|
|
"operationId": "UserService_AddUserAccounts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.AddUserAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/users/{id}:remove-accounts": {
|
|
"post": {
|
|
"summary": "Removes the specified Accounts from being associated with the provided User.",
|
|
"operationId": "UserService_RemoveUserAccounts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.RemoveUserAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/users/{id}:set-accounts": {
|
|
"post": {
|
|
"summary": "Set the Accounts associated to the User to exactly the list of provided in the request, removing any Accounts that are not specified.",
|
|
"operationId": "UserService_SetUserAccounts",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "body",
|
|
"in": "body",
|
|
"required": true,
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.services.v1.SetUserAccountsRequest"
|
|
}
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"controller.api.resources.accounts.v1.Account": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Account.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for the Account.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of this Account."
|
|
},
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Auth Method that is associated with this Account."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Account type."
|
|
},
|
|
"managed_group_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "Output only. managed_group_ids indicates IDs of the managed groups that currently contain this account",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Account contains all fields related to an Account resource"
|
|
},
|
|
"controller.api.resources.authmethods.v1.AuthMethod": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Auth Method.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope of which this Auth Method is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this Auth method.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The Auth Method type."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Auth Method type."
|
|
},
|
|
"is_primary": {
|
|
"type": "boolean",
|
|
"description": "Output only. Whether this auth method is the primary auth method for it's scope.\nTo change this value update the primary_auth_method_id field on the scope.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_collection_actions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"description": "Output only. The authorized actions for the scope's collections.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "AuthMethod contains all fields related to an Auth Method resource"
|
|
},
|
|
"controller.api.resources.authtokens.v1.AuthToken": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Auth Token.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The Scope in which this Auth Token was generated."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"token": {
|
|
"type": "string",
|
|
"description": "Output only. The token value, which will only be populated after authentication and is only ever visible to the end user whose login request resulted in this Auth Token being created.",
|
|
"readOnly": true
|
|
},
|
|
"user_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the User associated with this Auth Token.",
|
|
"readOnly": true
|
|
},
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Auth Method associated with this Auth Token.",
|
|
"readOnly": true
|
|
},
|
|
"account_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Account associated with this Auth Token.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"approximate_last_used_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The approximate time this Auth Token was last used.",
|
|
"readOnly": true
|
|
},
|
|
"expiration_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this Auth Token expires.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "AuthToken contains all fields related to an Auth Token resource"
|
|
},
|
|
"controller.api.resources.credentiallibraries.v1.CredentialLibrary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Credential Library.",
|
|
"readOnly": true
|
|
},
|
|
"credential_store_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Credential Store of which this Credential Library is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this Credential Library.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The Credential Library type."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Credential Library type."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "CredentialLibrary contains all fields related to an Credential Library resource"
|
|
},
|
|
"controller.api.resources.credentialstores.v1.CredentialStore": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Credential Store.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope of which this Credential Store is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this Credential Store.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The Credential Store type."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Credential Store type."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_collection_actions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"description": "Output only. The authorized actions for the scope's collections.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "CredentialStore contains all fields related to an Credential Store resource"
|
|
},
|
|
"controller.api.resources.groups.v1.Group": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Group.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the scope of which this Group is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this Group.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set descripton for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. Contains the list of member IDs in this Group.",
|
|
"readOnly": true
|
|
},
|
|
"members": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Member"
|
|
},
|
|
"description": "Output only. The members of this Group.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Group contains all fields related to a Group resource"
|
|
},
|
|
"controller.api.resources.groups.v1.Member": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the member.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Scope ID of the member.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.hostcatalogs.v1.HostCatalog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the host.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope of which this Host Catalog is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of Host Catalog."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "Attributes specific to the catalog type."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_collection_actions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"description": "Output only. The authorized actions for the scope's collections.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "HostCatalog manages Hosts and Host Sets"
|
|
},
|
|
"controller.api.resources.hosts.v1.Host": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Host.",
|
|
"readOnly": true
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string",
|
|
"description": "The Host Catalog of which this Host is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the resource."
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. A list of Host Sets containing this Host.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable to the specific Host type."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Host contains all fields related to a Host resource"
|
|
},
|
|
"controller.api.resources.hostsets.v1.HostSet": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Host Set.",
|
|
"readOnly": true
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string",
|
|
"description": "The Host Catalog of which this Host Set is a part."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the Host Set."
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. A list of Hosts in this Host Set.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Host Set type."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "HostSet is a collection of Hosts created and managed by a Host Catalog"
|
|
},
|
|
"controller.api.resources.managedgroups.v1.ManagedGroup": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the ManagedGroup.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for the ManagedGroup.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of this ManagedGroup."
|
|
},
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Auth Method that is associated with this ManagedGroup."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific ManagedGroup type."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The IDs of the current set of members (accounts) that are associated with this ManagedGroup.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "ManagedGroup contains all fields related to an ManagedGroup resource"
|
|
},
|
|
"controller.api.resources.roles.v1.Grant": {
|
|
"type": "object",
|
|
"properties": {
|
|
"raw": {
|
|
"type": "string",
|
|
"description": "Output only. The original user-supplied string.",
|
|
"readOnly": true
|
|
},
|
|
"canonical": {
|
|
"type": "string",
|
|
"description": "Output only. The canonically-formatted string.",
|
|
"readOnly": true
|
|
},
|
|
"json": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.GrantJson",
|
|
"description": "Output only. The JSON representation of the grant.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.GrantJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID, if set.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. The type, if set.",
|
|
"readOnly": true
|
|
},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The actions.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.Principal": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the principal.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. The type of the principal.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Scope of the principal.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.Role": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Role.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope containing this Role."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"grant_scope_id": {
|
|
"type": "string",
|
|
"description": "The Scope the grants will apply to. If the Role is at the global scope, this can be an org or project. If the Role is at an org scope, this can be a project within the org. It is invalid for this to be anything other than the Role's scope when the Role's scope is a project."
|
|
},
|
|
"principal_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The IDs (only) of principals that are assigned to this role.",
|
|
"readOnly": true
|
|
},
|
|
"principals": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Principal"
|
|
},
|
|
"description": "Output only. The principals that are assigned to this role.",
|
|
"readOnly": true
|
|
},
|
|
"grant_strings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The grants that this role provides for its principals.",
|
|
"readOnly": true
|
|
},
|
|
"grants": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Grant"
|
|
},
|
|
"description": "Output only. The parsed grant information.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Role contains all fields related to a Role resource"
|
|
},
|
|
"controller.api.resources.scopes.v1.Scope": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Scope.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope this resource is in. If this is the \"global\" Scope this field will be empty."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set descripton for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the resource."
|
|
},
|
|
"primary_auth_method_id": {
|
|
"type": "string",
|
|
"title": "The ID of the primary auth method for this scope. A primary auth method\nis allowed to vivify users when new accounts are created and is the source for the users account info"
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_collection_actions": {
|
|
"type": "object",
|
|
"additionalProperties": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object"
|
|
}
|
|
},
|
|
"description": "Output only. The authorized actions for the scope's collections.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Scope contains all fields related to a Scope resource"
|
|
},
|
|
"controller.api.resources.scopes.v1.ScopeInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Scope.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. The type of the Scope.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Output only. The name of the Scope, if any.",
|
|
"readOnly": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Output only. The description of the Scope, if any.",
|
|
"readOnly": true
|
|
},
|
|
"parent_scope_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the parent Scope, if any. This field will be empty if this is the \"global\" scope.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.sessions.v1.Session": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Session.",
|
|
"readOnly": true
|
|
},
|
|
"target_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Target that created this Session.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used when canceling this Session to ensure that the operation is acting on a known session state."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. Type of the Session (e.g. tcp).",
|
|
"readOnly": true
|
|
},
|
|
"expiration_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. After this time the connection will be expired, e.g. forcefully terminated.",
|
|
"readOnly": true
|
|
},
|
|
"auth_token_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Auth Token used to authenticate.",
|
|
"readOnly": true
|
|
},
|
|
"user_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the User that requested the Session.",
|
|
"readOnly": true
|
|
},
|
|
"host_set_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Host Set sourcing the Host for this Session.",
|
|
"readOnly": true
|
|
},
|
|
"host_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Host used by the Session.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Scope of the Session.",
|
|
"readOnly": true
|
|
},
|
|
"endpoint": {
|
|
"type": "string",
|
|
"description": "Output only. The endpoint of the Session; that is, the address to which the worker is proxying data.",
|
|
"readOnly": true
|
|
},
|
|
"states": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.SessionState"
|
|
},
|
|
"description": "Output only. The states of this Session in descending order from the current state to the first.",
|
|
"readOnly": true
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "Output only. The current status of this Session.",
|
|
"readOnly": true
|
|
},
|
|
"worker_info": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.WorkerInfo"
|
|
},
|
|
"description": "Output only. Worker information given to the client.",
|
|
"readOnly": true
|
|
},
|
|
"certificate": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Output only. The certificate generated for the session. Raw DER bytes.",
|
|
"readOnly": true
|
|
},
|
|
"termination_reason": {
|
|
"type": "string",
|
|
"description": "Output only. If the session is terminated, this provides a short description as to why.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Session contains all fields related to a Session resource"
|
|
},
|
|
"controller.api.resources.sessions.v1.SessionState": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"description": "The status of the Session, e.g. \"pending\", \"active\", \"canceling\", \"terminated\"."
|
|
},
|
|
"start_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time the Session entered this state.",
|
|
"readOnly": true
|
|
},
|
|
"end_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time the Session stopped being in this state.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.sessions.v1.WorkerInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"type": "string",
|
|
"description": "The address of the worker."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.CredentialLibrary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Credential Library."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Output only. The name of the Credential Library.",
|
|
"readOnly": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Output only. The description of the Credential Library.",
|
|
"readOnly": true
|
|
},
|
|
"credential_store_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Credential Store to which this Credential Library belongs.",
|
|
"readOnly": true
|
|
},
|
|
"purpose": {
|
|
"type": "string",
|
|
"description": "The library's purpose for this target."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. The type of the credential library.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.HostSet": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Host Set.",
|
|
"readOnly": true
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Host Catalog to which this Host Set belongs.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.SessionAuthorization": {
|
|
"type": "object",
|
|
"properties": {
|
|
"session_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Session.",
|
|
"readOnly": true
|
|
},
|
|
"target_id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Target authorizing this Session.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"user_id": {
|
|
"type": "string",
|
|
"description": "Output only. The User for which this Session was authorized.",
|
|
"readOnly": true
|
|
},
|
|
"host_set_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Host Set containing the Host being used for this Session.",
|
|
"readOnly": true
|
|
},
|
|
"host_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Host whose address is being used as the endpoint for this Session.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Output only. Type of the Session (e.g. tcp, ssh, etc.).",
|
|
"readOnly": true
|
|
},
|
|
"authorization_token": {
|
|
"type": "string",
|
|
"description": "Output only. The marshaled SessionAuthorizationData message containing all information that the proxy needs.",
|
|
"readOnly": true
|
|
},
|
|
"endpoint": {
|
|
"type": "string",
|
|
"description": "Output only. The endpoint address that the worker will connect to, useful for setting TLS parameters.",
|
|
"readOnly": true
|
|
},
|
|
"credentials": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.SessionCredential"
|
|
},
|
|
"description": "Output only. The credentials for this session.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "SessionAuthorization contains all fields related to authorization for a Session. It's in the Targets package because it's returned by a Target's authorize action."
|
|
},
|
|
"controller.api.resources.targets.v1.SessionCredential": {
|
|
"type": "object",
|
|
"properties": {
|
|
"credential_library": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.CredentialLibrary",
|
|
"description": "Output only. The library which generated this credential.",
|
|
"readOnly": true
|
|
},
|
|
"secret": {
|
|
"type": "string",
|
|
"description": "Output only. The secret of this credential base64 encoded.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"description": "A credential for a session."
|
|
},
|
|
"controller.api.resources.targets.v1.Target": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the resource.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The Scope of of this resource. This must be defined for creation of this resource, but is otherwise output only."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Required name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the Target."
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The IDs of the Host Sets associated with this Target."
|
|
},
|
|
"host_sets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.HostSet"
|
|
},
|
|
"description": "Output only. The Host Sets associated with this Target.",
|
|
"readOnly": true
|
|
},
|
|
"session_max_seconds": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Maximum total lifetime of a created Session, in seconds."
|
|
},
|
|
"session_connection_limit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"description": "Maximum number of connections allowed in a Session. Unlimited is indicated by the value -1."
|
|
},
|
|
"worker_filter": {
|
|
"type": "string",
|
|
"description": "Optional boolean expression to filter the workers that are allowed to satisfy this request."
|
|
},
|
|
"credential_library_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The IDs of the credential libraries associated with this Target."
|
|
},
|
|
"credential_libraries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.CredentialLibrary"
|
|
},
|
|
"description": "Output only. The credential libraries associated with this Target.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Target."
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "Target contains all fields related to a Target resource"
|
|
},
|
|
"controller.api.resources.users.v1.Account": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the Account.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "Output only. The Scope containing the Account.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.users.v1.User": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "Output only. The ID of the User.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope this resource is in."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Output only. Scope information for this resource.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "Optional name for identification purposes."
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "Optional user-set description for identification purposes."
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was created.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "Output only. The time this resource was last updated.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used in mutation requests, after the initial creation, to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"account_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. Contains the list of Account IDs linked to this User.",
|
|
"readOnly": true
|
|
},
|
|
"accounts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.Account"
|
|
},
|
|
"description": "Output only. The Accounts linked to this User.",
|
|
"readOnly": true
|
|
},
|
|
"authorized_actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Output only. The available actions on this resource for this user.",
|
|
"readOnly": true
|
|
},
|
|
"login_name": {
|
|
"type": "string",
|
|
"title": "Output only. login_name is a string that maps to the user's account \"login\nname\" from the scope's primary auth method",
|
|
"readOnly": true
|
|
},
|
|
"full_name": {
|
|
"type": "string",
|
|
"title": "Output only. full_name is a string that maps to the user's account name\nfrom the scope's primary auth method",
|
|
"readOnly": true
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"title": "Output only. email is a string that maps to the user's account email from\nthe scope's primary auth method",
|
|
"readOnly": true
|
|
},
|
|
"primary_account_id": {
|
|
"type": "string",
|
|
"title": "Output only. primary_account_id is a string that maps to the user's account\npublic_id from the scope's primary auth method",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "User contains all fields related to a User resource"
|
|
},
|
|
"controller.api.services.v1.AddGroupMembersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddGroupMembersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddHostSetHostsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of Host IDs which will be added to this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddHostSetHostsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddRoleGrantsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"grant_strings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddRoleGrantsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddRolePrincipalsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"principal_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddRolePrincipalsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddTargetCredentialLibrariesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"credential_library_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"credential_libraries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.services.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"description": "The ids from both credential_library_ids and credential_libraries are used.\nWhen using credential_library_ids the default value \"application\" is used\nfor the purpose."
|
|
},
|
|
"controller.api.services.v1.AddTargetCredentialLibrariesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddUserAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail."
|
|
},
|
|
"account_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddUserAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateLoginRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Auth Method in the system that should be used for authentication."
|
|
},
|
|
"token_type": {
|
|
"type": "string",
|
|
"description": "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\nto keep it safe from rogue JS in the browser."
|
|
},
|
|
"credentials": {
|
|
"type": "object",
|
|
"description": "Credentials are passed to the Auth Method; the valid keys and values depend on the type of Auth Method."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateLoginResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
},
|
|
"token_type": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The ID of the Auth Method in the system that should be used for authentication."
|
|
},
|
|
"token_type": {
|
|
"type": "string",
|
|
"description": "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\nto keep it safe from rogue JS in the browser."
|
|
},
|
|
"credentials": {
|
|
"type": "object",
|
|
"description": "Deprecated; use \"attributes\" instead."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "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": {
|
|
"type": "string",
|
|
"description": "The command to perform."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "Valid keys and values depend on the type of Auth Method as well as the command."
|
|
},
|
|
"command": {
|
|
"type": "string",
|
|
"description": "The command that was performed."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthorizeSessionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the target. Required unless some combination of scope_id/scope_name and name are set."
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of the target. When using this, scope_id or scope_name must be set."
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The scope ID containing the target, if specifying the target by name."
|
|
},
|
|
"scope_name": {
|
|
"type": "string",
|
|
"description": "The scope name containing the target, if specifying the target by name."
|
|
},
|
|
"host_id": {
|
|
"type": "string",
|
|
"description": "An optional parameter allowing specification of the particular Host within the Target's configured Host Sets to connect to during this Session."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthorizeSessionResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.SessionAuthorization"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CancelSessionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CancelSessionResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.Session"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ChangePasswordRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"current_password": {
|
|
"type": "string"
|
|
},
|
|
"new_password": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ChangePasswordResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ChangeStateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes specific to this auth method's state."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ChangeStateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateAccountResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateAuthMethodResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateCredentialLibraryResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateCredentialStoreResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateHostCatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateHostResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateHostSetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateManagedGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateRoleResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateScopeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateTargetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CreateUserResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"uri": {
|
|
"type": "string"
|
|
},
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.CredentialLibrary": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The id of the credential library."
|
|
},
|
|
"purpose": {
|
|
"type": "string",
|
|
"description": "The purpose of the credential library for this target. Currently this can\nonly be \"application\" or left empty (which defaults the value to\n\"application\")."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.DeleteAccountResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteAuthMethodResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteAuthTokenResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteCredentialLibraryResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteCredentialStoreResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteGroupResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteHostCatalogResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteHostResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteHostSetResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteManagedGroupResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteRoleResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteScopeResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteTargetResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteUserResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.GetAccountResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetAuthMethodResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetAuthTokenResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetCredentialLibraryResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetCredentialStoreResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetHostCatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetHostResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetHostSetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetManagedGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetRoleResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetScopeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetSessionResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.Session"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetTargetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.GetUserResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListAuthMethodsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListAuthTokensResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListCredentialLibrariesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListCredentialStoresResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListGroupsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListHostCatalogsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListHostsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListManagedGroupsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListRolesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListScopesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListSessionsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.Session"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListTargetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.ListUsersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"items": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveGroupMembersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveGroupMembersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveHostSetHostsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of Host IDs which will be removed from this Host Set."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveHostSetHostsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveRoleGrantsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"grant_strings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveRoleGrantsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveRolePrincipalsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"principal_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveRolePrincipalsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveTargetCredentialLibrariesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"credential_library_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveTargetCredentialLibrariesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveUserAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail."
|
|
},
|
|
"account_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveUserAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetGroupMembersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetGroupMembersResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetHostSetHostsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of Host IDs which will be set on this Host Set. Each Host referenced here must be a child of the same Host Catalog of which this Host Set is a child."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetHostSetHostsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetPasswordRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"password": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetPasswordResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetRoleGrantsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"grant_strings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetRoleGrantsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetRolePrincipalsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"principal_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetRolePrincipalsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetTargetCredentialLibrariesRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"credential_library_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
"credential_libraries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.services.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"description": "The ids from both credential_library_ids and credential_libraries are used.\nWhen using credential_library_ids the default value \"application\" is used\nfor the purpose."
|
|
},
|
|
"controller.api.services.v1.SetTargetCredentialLibrariesResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "Version is used to ensure this resource has not changed.\nThe mutation will fail if the version does not match the latest known good version."
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetUserAccountsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version ensures the User hasn't changed since it was last retrieved and if it has the request will fail."
|
|
},
|
|
"account_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetUserAccountsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateAccountResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.accounts.v1.Account"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateAuthMethodResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateCredentialLibraryResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentiallibraries.v1.CredentialLibrary"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateCredentialStoreResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.credentialstores.v1.CredentialStore"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Group"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateHostCatalogResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateHostResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hosts.v1.Host"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateHostSetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateManagedGroupResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.managedgroups.v1.ManagedGroup"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateRoleResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Role"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateScopeResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.Scope"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateTargetResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.UpdateUserResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.users.v1.User"
|
|
}
|
|
}
|
|
},
|
|
"google.protobuf.NullValue": {
|
|
"type": "string",
|
|
"enum": [
|
|
"NULL_VALUE"
|
|
],
|
|
"default": "NULL_VALUE",
|
|
"description": "`NullValue` is a singleton enumeration to represent the null value for the\n`Value` type union.\n\n The JSON representation for `NullValue` is JSON `null`.\n\n - NULL_VALUE: Null value."
|
|
}
|
|
}
|
|
}
|