{ "components": { "schemas": { "ACL": { "properties": { "cidr": { "description": "The given IP/IP Range that is permitted to access.", "type": "string" }, "id": { "description": "A auto generated unique id which identifies the acl.", "format": "uuid", "type": "string" } }, "required": [ "id", "cidr" ] }, "Approle": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple approles.", "type": "string" }, "role_id": { "description": "Identifier used for authentication", "format": "uuid", "type": "string" }, "secret_id_num_uses": { "format": "int64", "type": "integer" }, "secret_id_ttl": { "description": "Token TTL in time.Duration format (eg 15m for 15 minutes, 1h for 1 hour).", "pattern": "^[0-9]+[smh]$", "type": "string" }, "write": { "description": "Is true if the approle has write access to the secrets engine. Is false for a read-only approle.", "type": "boolean" } }, "required": [ "role_id", "write", "secret_id_num_uses", "secret_id_ttl", "description" ] }, "ApproleList": { "properties": { "approles": { "items": { "$ref": "#/components/schemas/Approle" }, "type": "array" } }, "required": [ "approles" ] }, "ApproleSecret": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple approle secrets.", "type": "string" }, "num_uses": { "format": "int64", "type": "integer" }, "secret_id": { "description": "Identifier used for authentication, returned only at creation", "format": "uuid", "type": "string" }, "ttl": { "description": "Token TTL in time.Duration format (eg 15m for 15 minutes, 1h for 1 hour).", "pattern": "^[0-9]+[smh]$", "type": "string" }, "version": { "description": "Accessor used for handling secrets", "format": "int64", "type": "integer" } }, "required": [ "version", "num_uses", "ttl", "description" ] }, "ApproleSecretList": { "properties": { "secretIds": { "items": { "$ref": "#/components/schemas/ApproleSecret" }, "type": "array" } }, "required": [ "secretIds" ] }, "BadRequest": { "properties": { "message": { "description": "The error message for bad requests", "example": "invalid instance name", "type": "string" } }, "required": [ "message" ], "type": "object" }, "Conflict": { "properties": { "message": { "description": "The error message for conflicts", "example": "User limit reached. Contact the support.", "type": "string" } }, "required": [ "message" ], "type": "object" }, "CreateACLPayload": { "properties": { "cidr": { "description": "The given IP/IP Range that is permitted to access.", "type": "string" } }, "required": [ "cidr" ] }, "CreateApprolePayload": { "properties": { "description": { "default": "", "description": "A user chosen description to differentiate between multiple approles.", "type": "string", "x-go-type-skip-optional-pointer": true }, "secret_id_num_uses": { "default": 0, "format": "int64", "type": "integer" }, "secret_id_ttl": { "default": "0s", "description": "Token TTL in time.Duration format (eg 15m for 15 minutes, 1h for 1 hour).", "pattern": "^[0-9]+[smh]$", "type": "string" }, "write": { "default": false, "description": "Is true if the approle has write access to the secrets engine. Is false for a read-only approle.", "type": "boolean" } } }, "CreateApproleSecretIdPayload": { "properties": { "description": { "default": "", "description": "A user chosen description to differentiate between multiple approle secrets.", "type": "string", "x-go-type-skip-optional-pointer": true } } }, "CreateInstancePayload": { "properties": { "kmsKey": { "$ref": "#/components/schemas/KmsKeyPayload" }, "name": { "description": "A user chosen name to distinguish multiple secrets manager instances.", "type": "string" } }, "required": [ "name" ] }, "CreateUserPayload": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple users.", "type": "string" }, "write": { "description": "Is true if the user has write access to the secrets engine. Is false for a read-only user.", "type": "boolean" } }, "required": [ "write", "description" ] }, "Instance": { "properties": { "apiUrl": { "description": "The API endpoint for connecting to the secrets engine.", "type": "string" }, "creationFinishedDate": { "description": "The date and time the creation of the Secrets Manager instance was finished.", "type": "string" }, "creationStartDate": { "description": "The date and time the creation of the Secrets Manager instance was triggered.", "type": "string" }, "id": { "description": "A auto generated unique id which identifies the secrets manager instances.", "format": "uuid", "type": "string" }, "kmsKey": { "$ref": "#/components/schemas/KmsKeyPayload" }, "name": { "description": "A user chosen name to distinguish multiple secrets manager instances.", "type": "string" }, "secretCount": { "description": "The number of secrets currently stored inside of the instance. This value will be updated once per hour.", "format": "int64", "type": "integer" }, "secretsEngine": { "description": "The name of the secrets engine.", "type": "string" }, "state": { "description": "The current state of the Secrets Manager instance.", "type": "string" }, "updateFinishedDate": { "type": "string" }, "updateStartDate": { "type": "string" } }, "required": [ "id", "name", "secretsEngine", "apiUrl", "state", "creationStartDate", "secretCount" ] }, "KmsKeyPayload": { "description": "The key for secret encryption and decryption.", "properties": { "keyId": { "description": "The key UUID.", "format": "uuid", "type": "string" }, "keyRingId": { "description": "The key ring UUID the key is part of.", "format": "uuid", "type": "string" }, "keyVersion": { "description": "The Key version number.", "format": "int64", "type": "integer" }, "serviceAccountEmail": { "description": "The Service account email that will consume the key. Must be in the same project as the Secrets Manager instance.", "type": "string" } }, "required": [ "serviceAccountEmail", "keyRingId", "keyId", "keyVersion" ], "type": "object" }, "ListACLsResponse": { "properties": { "acls": { "items": { "$ref": "#/components/schemas/ACL" }, "type": "array" } }, "required": [ "acls" ] }, "ListInstancesResponse": { "properties": { "instances": { "items": { "$ref": "#/components/schemas/Instance" }, "type": "array" } }, "required": [ "instances" ] }, "ListUsersResponse": { "properties": { "users": { "items": { "$ref": "#/components/schemas/User" }, "type": "array" } }, "required": [ "users" ] }, "NotFound": { "properties": { "message": { "description": "The error message for not found resources", "example": "Not Found", "type": "string" } }, "required": [ "message" ], "type": "object" }, "Unauthorized": { "description": "The error message, such as \"Jwt is missing\"", "example": "Jwt is missing", "type": "string" }, "UpdateACLPayload": { "properties": { "cidr": { "description": "The given IP/IP Range that is permitted to access.", "type": "string" } }, "required": [ "cidr" ] }, "UpdateACLsPayload": { "properties": { "cidrs": { "items": { "$ref": "#/components/schemas/UpdateACLPayload" }, "type": "array" } }, "required": [ "cidr" ] }, "UpdateApprolePayload": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple approles.", "type": "string" }, "secret_id_num_uses": { "format": "int64", "type": "integer" }, "secret_id_ttl": { "description": "Token TTL in time.Duration format (eg 15m for 15 minutes, 1h for 1 hour).", "pattern": "^[0-9]+[smh]$", "type": "string" }, "write": { "description": "Is true if the approle has write access to the secrets engine. Is false for a read-only approle.", "type": "boolean" } } }, "UpdateApproleSecretIdPayload": { "properties": { "description": { "default": "", "description": "A user chosen description to differentiate between multiple approle secrets.", "type": "string", "x-go-type-skip-optional-pointer": true } } }, "UpdateInstancePayload": { "properties": { "kmsKey": { "$ref": "#/components/schemas/KmsKeyPayload" }, "name": { "description": "A user chosen name to distinguish multiple secrets manager instances.", "type": "string" } }, "required": [ "name" ] }, "UpdateUserPayload": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple users.", "type": "string" }, "write": { "description": "Is true if the user has write access to the secrets engine. Is false for a read-only user.", "type": "boolean" } } }, "User": { "properties": { "description": { "description": "A user chosen description to differentiate between multiple users.", "type": "string" }, "id": { "description": "A auto generated unique id which identifies the users.", "format": "uuid", "type": "string" }, "password": { "description": "A auto generated password for logging in with the user.", "type": "string" }, "username": { "description": "A auto generated username for logging in with the user.", "type": "string" }, "write": { "description": "Is true if the user has write access to the secrets engine. Is false for a read-only user.", "type": "boolean" } }, "required": [ "id", "username", "password", "write", "description" ] } } }, "info": { "description": "This API provides endpoints for managing the Secrets-Manager.\n", "title": "STACKIT Secrets Manager API V1", "version": "1.4.3" }, "openapi": "3.0.3", "paths": { "/v1/projects/{projectId}/instances": { "get": { "description": "Returns a list of all Secrets Manager instances within the project.", "operationId": "ListInstances", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInstancesResponse" } } }, "description": "Successful response with all instances." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "actions": [ "secrets-manager.instance.list" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "description": "Creates a new Secrets Manager instance within the project.", "operationId": "CreateInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateInstancePayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "Instance was created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Invalid instance name." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "actions": [ "secrets-manager.instance.create" ], "resource-id": "projectId", "resource-id-type": "dynamic", "resource-type": "project" } } }, "/v1/projects/{projectId}/instances/{instanceId}": { "delete": { "description": "Deletes the given Secrets Manager instance.", "operationId": "DeleteInstance", "responses": { "204": { "description": "Instance was deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.delete" ] } }, "get": { "description": "Returns the details for the given Secrets Manager instance.", "operationId": "GetInstance", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Instance" } } }, "description": "Instance details successfully retrieved." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "description": "Updates the given Secrets Manager instance.", "operationId": "UpdateInstance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateInstancePayload" } } }, "required": true }, "responses": { "201": { "description": "Instance was updated successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Invalid instance name.'" }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "409": { "description": "Conflict. The resource is not ready yet. Please try again later." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/acls": { "get": { "description": "Returns the acls for the given Secrets Manager instance.", "operationId": "ListACLs", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListACLsResponse" } } }, "description": "All acls for the Secrets Manager instance have been returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "description": "Creates a new Secrets Manager acl within the project.", "operationId": "CreateACL", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateACLPayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ACL" } } }, "description": "Acl was created successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Cidr not valid." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } }, "description": "Conflict. ACLs limit reached. Contact the support." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } }, "put": { "description": "Changes a list of ACLs within the project.", "operationId": "UpdateACLs", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateACLsPayload" } } }, "required": true }, "responses": { "200": { "description": "Acls were changed successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. One or more Cidrs are not valid." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. One or more Cidrs not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } }, "description": "Conflict. ACLs limit reached. Contact the support." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/acls/{aclId}": { "delete": { "description": "Deletes the given acl.", "operationId": "DeleteACL", "responses": { "204": { "description": "Acl was deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or acl not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } }, "get": { "description": "Returns the details for the given acl.", "operationId": "GetACL", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ACL" } } }, "description": "The details for the acl have been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or acl not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The acl UUID of the Secrets Manager instance.", "in": "path", "name": "aclId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "description": "Updates the ip ranges for the acl.", "operationId": "UpdateACL", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateACLPayload" } } }, "required": true }, "responses": { "200": { "description": "The ip range for the acl have been successfully updated." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Cidr not valid." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or acl not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/approles": { "get": { "description": "Returns the approles for the given Secrets Manager instance.", "operationId": "GetApproles", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproleList" } } }, "description": "All approles for the Secrets Manager instance have been returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "description": "Creates a new approle for the given Secrets Manager instance.", "operationId": "CreateApprole", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApprolePayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Approle" } } }, "description": "The approle has been created for the Secrets Manager instance." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad request. Approle description too long." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } }, "description": "Conflict. Approle limit reached. Contact the support." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/approles/{roleId}": { "delete": { "description": "Deletes the given approle.", "operationId": "DeleteApprole", "responses": { "204": { "description": "Approle was deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } }, "get": { "description": "Returns the details for the given approle.", "operationId": "GetApprole", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Approle" } } }, "description": "The details for the approle have been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The approle with permissions on the Secrets Manager instance.", "in": "path", "name": "roleId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "description": "Updates the details for the given approle.", "operationId": "UpdateApprole", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApprolePayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Approle" } } }, "description": "The details for the approle have been successfully updated." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Approle parameters incorrect." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/approles/{roleId}/secretids": { "get": { "description": "Returns the secret id list for the given Secrets Manager instance and approle.", "operationId": "ListApproleSecretIds", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproleSecretList" } } }, "description": "All secret versions for the Secrets Manager instance and approle have been returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The approle with permissions on the Secrets Manager instance.", "in": "path", "name": "roleId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "description": "Generate new secret id for the given approle.", "operationId": "CreateApproleSecretId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateApproleSecretIdPayload" } } }, "required": true }, "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproleSecret" } } }, "description": "The secret id for the approle has been successfully created." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Approle secret id parameters incorrect." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/approles/{roleId}/secretids/{secretIdVersion}": { "delete": { "description": "Deletes the secret id by its given version.", "operationId": "DeleteApproleSecretId", "responses": { "204": { "description": "Secret Id was deleted successfully." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle or approle secret not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } }, "get": { "description": "Read the properties of a given secret id by its given version.", "operationId": "GetApproleSecretId", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproleSecret" } } }, "description": "The approle secret data has been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Approle parameters incorrect." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle or approle secret not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The approle with permissions on the Secrets Manager instance.", "in": "path", "name": "roleId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The version of the secret id.", "in": "path", "name": "secretIdVersion", "required": true, "schema": { "format": "int64", "type": "integer" } } ], "put": { "description": "Update the description of a secret id by its given version.", "operationId": "UpdateApproleSecretId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateApproleSecretIdPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApproleSecret" } } }, "description": "The approle secret id has been successfully updated." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. Approle parameters incorrect." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or approle or approle secret not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/users": { "get": { "description": "Returns the users for the given Secrets Manager instance.", "operationId": "ListUsers", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListUsersResponse" } } }, "description": "All users for the Secrets Manager instance have been returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "post": { "description": "Creates a new user for the given Secrets Manager instance.", "operationId": "CreateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserPayload" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "The user has been created for the Secrets Manager instance." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad request. User description too long." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance not found." }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Conflict" } } }, "description": "Conflict. User limit reached. Contact the support." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } }, "/v1/projects/{projectId}/instances/{instanceId}/users/{userId}": { "delete": { "description": "Deletes the given user.", "operationId": "DeleteUser", "responses": { "204": { "description": "Instance was deleted successfully" }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or user not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } }, "get": { "description": "Returns the details for the given user.", "operationId": "GetUser", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/User" } } }, "description": "The details for the user have been successfully returned." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or user not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.get" ] } }, "parameters": [ { "description": "The STACKIT portal project UUID the Secrets Manager instance is part of.", "in": "path", "name": "projectId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The Secrets Manager instance UUID.", "in": "path", "name": "instanceId", "required": true, "schema": { "format": "uuid", "type": "string" } }, { "description": "The user UUID with permissions on the Secrets Manager instance.", "in": "path", "name": "userId", "required": true, "schema": { "format": "uuid", "type": "string" } } ], "put": { "description": "Updates the details for the given user.", "operationId": "UpdateUser", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUserPayload" } } }, "required": true }, "responses": { "200": { "description": "The details for the user have been successfully updated." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } }, "description": "Bad Request. User description too long." }, "401": { "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Unauthorized" } } }, "description": "Unauthorized. You may have provided no or wrong credentials." }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NotFound" } } }, "description": "Not found. Instance or user not found." }, "500": { "description": "Internal server error. The application experienced some unexpected situation." } }, "x-stackit-authorization": { "disabled": true, "implicit-actions": [ "secrets-manager.instance.update" ] } } } }, "servers": [ { "url": "https://secrets-manager.api.{region}stackit.cloud", "variables": { "region": { "default": "eu01.", "enum": [ "eu01." ] } } } ] }