latestOpenAPI 3.0.02026-08-10221235717.8 KB

e21ad140ec3c

public

ResourceAccount

Create a new Resource Account in the organization.

post/orgs/{orgId}/resources/accounts

Path parameters

orgIdstring required

The Organization ID.

Query parameters

dry_runboolean

Validate the request but do not persist the change.

check_credentialboolean

Validate that the Account credential authenticates successfully.

Request body

credentialsobject required

Credentials associated with the account.

idstring required

Unique identifier for the account (in scope of the organization it belongs to).

namestring required

Display name.

typestring required

The type of the account

Example request

{
  "credentials": {
    "password": "***",
    "username": "***"
  },
  "id": "gcp-dev-postgres",
  "name": "GCP Dev Postgres",
  "type": "gcp-service-account"
}

Response

The newly created Resources Account details.

created_atstring date-time required

The timestamp of when the account was created.

created_bystring required

The ID of the user who created the account.

idstring required

Unique identifier for the account (in scope of the organization it belongs to).

is_usedboolean required

Indicates if this account is being used (referenced) by any resource definition or active resource.

namestring required

Display name.

typestring required

The type of the account

Example response

{
  "created_at": "2020-05-22T14:58:07Z",
  "created_by": "test-user",
  "id": "gcp-dev-postgres",
  "is_default": false,
  "is_used": true,
  "name": "GCP Dev Postgres",
  "type": "gcp"
}