mirror of https://github.com/hashicorp/boundary
You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
4277 lines
119 KiB
4277 lines
119 KiB
{
|
|
"swagger": "2.0",
|
|
"info": {
|
|
"title": "Controller API",
|
|
"description": "API for managing resources associated with Controllers.",
|
|
"version": "0.0.1"
|
|
},
|
|
"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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"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 AuthMethods",
|
|
"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": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a single AuthMethod",
|
|
"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": "AuthenticationService_Authenticate",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "auth_method_id",
|
|
"description": "The id to the authmethod in the system being used for authentication. The auth method must be in the scope\nbeing logged in to.",
|
|
"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.AuthenticationService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-methods/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single AuthMethod",
|
|
"operationId": "AuthMethodService_GetAuthMethod",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authmethods.v1.AuthMethod"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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 AuthMethod",
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthMethodService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-tokens": {
|
|
"get": {
|
|
"summary": "Lists all AuthTokens",
|
|
"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": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthTokenService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/auth-tokens/{id}": {
|
|
"get": {
|
|
"summary": "Gets a single AuthToken",
|
|
"operationId": "AuthTokenService_GetAuthToken",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.AuthTokenService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes an AuthTokens",
|
|
"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/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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.GroupService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/groups/{id}:add-members": {
|
|
"post": {
|
|
"summary": "Adds Users as 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 HostCatalogs",
|
|
"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": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Creates a HostCatalog",
|
|
"description": "Creates a single host catalog under the specified scope",
|
|
"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 HostCatalog",
|
|
"description": "Gets a single Host Catalog with the provided identifier.",
|
|
"operationId": "HostCatalogService_GetHostCatalog",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostcatalogs.v1.HostCatalog"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Deletes a HostCatalog",
|
|
"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 HostCatalog",
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostCatalogService"
|
|
]
|
|
}
|
|
},
|
|
"/v1/host-sets": {
|
|
"get": {
|
|
"summary": "List all HostSets 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": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
},
|
|
"post": {
|
|
"summary": "Create a HostSet",
|
|
"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 HostSet",
|
|
"operationId": "HostSetService_GetHostSet",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.hostsets.v1.HostSet"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"type": "string"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "string"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostSetService"
|
|
]
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a HostSet",
|
|
"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 HostSet",
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"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",
|
|
"description": "This host set's 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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.HostService"
|
|
]
|
|
}
|
|
},
|
|
"/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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"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 of the token making 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": "view",
|
|
"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_role_creation",
|
|
"in": "query",
|
|
"required": false,
|
|
"type": "boolean",
|
|
"format": "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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"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": {
|
|
"post": {
|
|
"summary": "Authorizes a Session",
|
|
"operationId": "TargetService_AuthorizeSession",
|
|
"responses": {
|
|
"200": {
|
|
"description": "",
|
|
"schema": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.SessionAuthorization"
|
|
}
|
|
}
|
|
},
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"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-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-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": "view",
|
|
"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"
|
|
},
|
|
{
|
|
"name": "view",
|
|
"in": "query",
|
|
"required": false,
|
|
"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": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"collectionFormat": "multi"
|
|
}
|
|
],
|
|
"tags": [
|
|
"controller.api.services.v1.UserService"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"definitions": {
|
|
"controller.api.resources.accounts.v1.Account": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Account\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set descripton for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of this account. Possible values are: \"password\", \"oidc\"."
|
|
},
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The auth method this account is created for.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applicable for the specific Account type."
|
|
}
|
|
},
|
|
"title": "Account contains all fields related to an auth Account resource"
|
|
},
|
|
"controller.api.resources.authmethods.v1.AuthMethod": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the AuthMethod\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"title": "The id of the scope this resource is a part of"
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The auth method type. This can be \"password\" or \"oidc\"."
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applied for the specific Auth Method type."
|
|
}
|
|
},
|
|
"title": "AuthMethod contains all fields related to a AuthMethod resource"
|
|
},
|
|
"controller.api.resources.authtokens.v1.AuthToken": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the AuthToken\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The scope this auth token is in."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"token": {
|
|
"type": "string",
|
|
"description": "The token value, which will only be populated after authentication and is\nonly ever visible to the end user whose login request resulted in this\nauth token being created.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"user_id": {
|
|
"type": "string",
|
|
"description": "The id of the user of this AuthToken.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The id of the auth method of this AuthToken.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"account_id": {
|
|
"type": "string",
|
|
"description": "The id of the auth method account of this AuthToken.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"approximate_last_used_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The approximate time this AuthToken was last used.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"expiration_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this AuthToken expires.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
},
|
|
"title": "AuthToken contains all fields related to an AuthToken resource"
|
|
},
|
|
"controller.api.resources.groups.v1.Group": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Project\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The id of the scope this resource is a part of."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set descripton for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"member_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "Contains the list of member ids in this group.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"members": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.groups.v1.Member"
|
|
},
|
|
"description": "The members of this group.\nOutput only.",
|
|
"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": "The ID of the member.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The scope ID of the member.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.hostcatalogs.v1.HostCatalog": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the host\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The id of the scope this resource belongs to."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "The type of the resource, to help differentiate schemas"
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"title": "Attributes specific to the catalog type"
|
|
}
|
|
},
|
|
"title": "HostCatalog manages Hosts and HostSets"
|
|
},
|
|
"controller.api.resources.hosts.v1.Host": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the host\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string",
|
|
"title": "The host catalog this host set is a part of\nOutput only"
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "The type of the resource, to help differentiate schemas"
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host sets this host is in\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applied for the specific host type."
|
|
}
|
|
},
|
|
"title": "Host contains all fields related to a Host resource"
|
|
},
|
|
"controller.api.resources.hostsets.v1.HostSet": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the host\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "The type of the resource, to help differentiate schemas"
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string",
|
|
"title": "The host catalog this host set is a part of\nOutput only"
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of hosts in this host set\nTODO: Figure out if this should be in the basic HostSet view and what\nview to use on the Hosts.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applied for the specific host set type."
|
|
}
|
|
},
|
|
"title": "HostSet is a collection of Hosts created and managed by a HostCatalog"
|
|
},
|
|
"controller.api.resources.roles.v1.Grant": {
|
|
"type": "object",
|
|
"properties": {
|
|
"raw": {
|
|
"type": "string",
|
|
"description": "The original user-supplied string.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"canonical": {
|
|
"type": "string",
|
|
"description": "The canonically formatted string.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"json": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.GrantJson",
|
|
"description": "The JSON representation of the grant.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.GrantJson": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID, if set.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type, if set.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The actions.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.Principal": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the principal.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the principal.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The scope ID of the principal.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.roles.v1.Role": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Role\nOutput only.",
|
|
"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": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this resource\nhas not changed and to fail the write if it has."
|
|
},
|
|
"grant_scope_id": {
|
|
"type": "string",
|
|
"description": "The scope the grants will apply to. If the role is at the global scope,\nthis can be an org or project. If the role is at an org\nscope, this can be a project within the org. It is invalid for\nthis to be anything other than the role's scope when the role's scope is\na project."
|
|
},
|
|
"principal_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The IDs (only) of principals that are assigned to this role.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"principals": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Principal"
|
|
},
|
|
"description": "The principals that are assigned to this role.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"grant_strings": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The grants that this role provides for its principals.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"grants": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.roles.v1.Grant"
|
|
},
|
|
"description": "The parsed grant information.\nOutput only.",
|
|
"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": "The ID of the Scope\nOutput only.",
|
|
"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": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set descripton for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this\nresource has not changed and to fail the write if it has.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "The type of the resource"
|
|
}
|
|
},
|
|
"title": "Scope contains all fields related to a Scope resource"
|
|
},
|
|
"controller.api.resources.scopes.v1.ScopeInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Scope\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "The type of the Scope\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"description": "The name of the scope, if any\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"description": "The description of the scope, if any\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"parent_scope_id": {
|
|
"type": "string",
|
|
"description": "The ID of the parent scope, if any\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.sessions.v1.Session": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"target_id": {
|
|
"type": "string",
|
|
"description": "The id of the parent of this resource. This must be defined for creation\nof this resource, but is otherwise read only."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"expiration_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"title": "After this time the connection will be expired, e.g. forcefully terminated"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this\nresource has not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"title": "Type of the session (e.g. tcp, ssh, etc.)"
|
|
},
|
|
"auth_token_id": {
|
|
"type": "string",
|
|
"description": "The id of the token used to authenticate."
|
|
},
|
|
"user_id": {
|
|
"type": "string",
|
|
"title": "The ID of the user that requested the session"
|
|
},
|
|
"host_set_id": {
|
|
"type": "string",
|
|
"title": "The host set id used by the session's target"
|
|
},
|
|
"host_id": {
|
|
"type": "string",
|
|
"title": "The host id used by the session"
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"title": "The scope of the session"
|
|
},
|
|
"endpoint": {
|
|
"type": "string",
|
|
"title": "The endpoint of the session"
|
|
},
|
|
"states": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.SessionState"
|
|
},
|
|
"description": "The states of this session in descending from the current state to the\nfirst."
|
|
},
|
|
"status": {
|
|
"type": "string",
|
|
"description": "The name of the current status of this session."
|
|
},
|
|
"worker_info": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.sessions.v1.WorkerInfo"
|
|
},
|
|
"description": "Worker information. The first worker in the slice should be prioritized."
|
|
},
|
|
"certificate": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "Deprecated, to be moved to another proto by another PR:\nThe certificate to use when connecting (or if using custom certs, to\nserve as the \"login\"). Raw DER bytes."
|
|
},
|
|
"private_key": {
|
|
"type": "string",
|
|
"format": "byte",
|
|
"description": "The private key to use when connecting (or if using custom certs, to pass\nas the \"password\")."
|
|
}
|
|
},
|
|
"title": "Session contains all fields related to a Session resource"
|
|
},
|
|
"controller.api.resources.sessions.v1.SessionState": {
|
|
"type": "object",
|
|
"properties": {
|
|
"status": {
|
|
"type": "string",
|
|
"description": "This is the status of the session. For example \"pending\", \"active\",\n\"canceling\", \"terminated\"."
|
|
},
|
|
"start_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time the session entered this state.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"end_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time the session stopped being in this state.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.sessions.v1.WorkerInfo": {
|
|
"type": "object",
|
|
"properties": {
|
|
"address": {
|
|
"type": "string",
|
|
"title": "The address of the worker"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.HostSet": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"host_catalog_id": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.SessionAuthorization": {
|
|
"type": "object",
|
|
"properties": {
|
|
"session_id": {
|
|
"type": "string",
|
|
"description": "The ID of the session\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"target_id": {
|
|
"type": "string",
|
|
"description": "The id of the target authorizing this session. This must be defined for\ncreation of this resource, but is otherwise read only.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"type": {
|
|
"type": "string",
|
|
"description": "Type of the session (e.g. tcp, ssh, etc.)\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"authorization_token": {
|
|
"type": "string",
|
|
"description": "The marshaled SessionAuthorizationData message containing all information\nthat the proxy needs.\nOutput only.",
|
|
"readOnly": true
|
|
}
|
|
}
|
|
},
|
|
"controller.api.resources.targets.v1.Target": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"scope_id": {
|
|
"type": "string",
|
|
"description": "The id of the parent of this resource. This must be defined for creation of this resource, but is otherwise\nread only."
|
|
},
|
|
"scope": {
|
|
"$ref": "#/definitions/controller.api.resources.scopes.v1.ScopeInfo",
|
|
"description": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Required name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this\nresource has not changed and to fail the write if it has."
|
|
},
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "The ids of the host sets that make up this target."
|
|
},
|
|
"host_sets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.HostSet"
|
|
},
|
|
"description": "The host sets that make up this target.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"session_max_seconds": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"title": "Maximum total lifetime of a created session, in seconds"
|
|
},
|
|
"session_connection_limit": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"title": "Maximum number of connections in a session"
|
|
},
|
|
"attributes": {
|
|
"type": "object",
|
|
"description": "The attributes that are applied for the specific Target type."
|
|
}
|
|
},
|
|
"title": "Target contains all fields related to a Target resource"
|
|
},
|
|
"controller.api.resources.users.v1.User": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"description": "The ID of the Project\nOutput only.",
|
|
"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": "Scope information for this resource\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"title": "Optional name for identification purposes"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"title": "Optional user-set description for identification purposes"
|
|
},
|
|
"created_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was created\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"updated_time": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"description": "The time this resource was last updated.\nOutput only.",
|
|
"readOnly": true
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version can be used in subsequent write requests to ensure this\nresource has not changed and to fail the write if it has."
|
|
}
|
|
},
|
|
"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": "The version ensures the group hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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"
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host IDs which will be added to this host set. Each host\nreferenced here must be a child of the same host catalog that this host\nset is a child of."
|
|
}
|
|
}
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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.AddTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"title": "A list of host set IDs which will be added to this target. Each host set\nreferenced here must be a child of a host catalog in the same scope as this\ntarget"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AddTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"auth_method_id": {
|
|
"type": "string",
|
|
"description": "The id to the authmethod in the system being used for authentication. The auth method must be in the scope\nbeing logged in to."
|
|
},
|
|
"token_type": {
|
|
"type": "string",
|
|
"description": "This can be \"cookie\" or \"token\". If not provided, \"token\" will be used."
|
|
},
|
|
"credentials": {
|
|
"type": "object",
|
|
"description": "credentials are the different possible credential names depending on what type of auth method is used.\nFor password auth method: should include only \"name\" and \"password\"."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthenticateResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.authtokens.v1.AuthToken"
|
|
},
|
|
"token_type": {
|
|
"type": "string",
|
|
"description": "This can be \"cookie\" or \"token\". If not present, \"token\" should be assumed."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.AuthorizeSessionRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"host_id": {
|
|
"type": "string",
|
|
"description": "An optional parameter allowing specification of the particular host within\nthe target's 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"
|
|
},
|
|
"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.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.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.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.DeleteAccountResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteAuthMethodResponse": {
|
|
"type": "object"
|
|
},
|
|
"controller.api.services.v1.DeleteAuthTokenResponse": {
|
|
"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.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.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.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.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.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": "The version ensures the group hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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",
|
|
"description": "This host set's id."
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host IDs which should not be in the host set when this request\nreturns."
|
|
}
|
|
}
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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.RemoveTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host set IDs which should not be in the target when this request\nreturns."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.RemoveTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetGroupMembersRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64",
|
|
"description": "The version ensures the group hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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"
|
|
},
|
|
"host_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host IDs which will be set on this host set. Each host\nreferenced here must be a child of the same host catalog that this host\nset is a child of."
|
|
}
|
|
}
|
|
},
|
|
"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"
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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": "The version ensures the role hasn't changed since it was last retrieved and if\nit has the request will fail."
|
|
},
|
|
"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.SetTargetHostSetsRequest": {
|
|
"type": "object",
|
|
"properties": {
|
|
"id": {
|
|
"type": "string"
|
|
},
|
|
"version": {
|
|
"type": "integer",
|
|
"format": "int64"
|
|
},
|
|
"host_set_ids": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "string"
|
|
},
|
|
"description": "A list of host set IDs which will be set on this target. Each host set\nreferenced here must be a child of a host catalog in the same scope as this\ntarget."
|
|
}
|
|
}
|
|
},
|
|
"controller.api.services.v1.SetTargetHostSetsResponse": {
|
|
"type": "object",
|
|
"properties": {
|
|
"item": {
|
|
"$ref": "#/definitions/controller.api.resources.targets.v1.Target"
|
|
}
|
|
}
|
|
},
|
|
"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.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.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."
|
|
}
|
|
}
|
|
}
|