Humanitec ResourceAccount API

ResourceAccount represents the account being used to access a resource.Resource Accounts hold credentials that are required to provision and manage resources.

Documentation Provider Profile APIs.io OpenAPI GitHub

Humanitec ResourceAccount API is one of 45 APIs that Humanitec publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ResourceAccount. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 6 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.0, at version 0.28.24.

Requests are made against a single base URL, https://api.humanitec.io/.

6 operations 3 paths 14 schemas 1 DELETE2 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.0.0

API Version

0.28.24

Base URL

https://api.humanitec.io

Contact

Humanitec Support

Resource Areas

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 2 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

ResourceAccount 6

ResourceAccount represents the account being used to access a resource. Resource Accounts hold credentials that are required to provision and manage resources.

GET

/orgs/{orgId}/resources/accounts

List Resource Accounts in the organization.

listResourceAccounts 1 param → 200500

POST

/orgs/{orgId}/resources/accounts

Create a new Resource Account in the organization.

createResourceAccount 3 params body → 200204400401409500

GET

/orgs/{orgId}/resources/accounts/{accId}

Get a Resource Account.

getResourceAccount 2 params → 200404500

DELETE

/orgs/{orgId}/resources/accounts/{accId}

Delete an unused Resource Account.

deleteResourceAccount 2 params → 204400404500

PATCH

/orgs/{orgId}/resources/accounts/{accId}

Update a Resource Account.

patchResourceAccount 4 params body → 200204400404500

POST

/orgs/{orgId}/resources/accounts/{accId}/actions/check

Check the credentials of an existing Resource Account

checkResourceAccount 2 params → 200400

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are ActiveResourceResponse (20 properties), ResourceDefinitionResponse (16 properties), ResourceAccountResponse (6 properties), MatchingCriteriaResponse (6 properties). Each schema is shown below with its type and property counts.

ActiveResourceResponse

object

Active Resources represent the concrete resources provisioned for an Environment. They are provisioned on the first deployment after a dependency on a particul…

20 properties 17 required

CheckResourceAccountField

object

An identity field or property resulting from the account check.

3 properties 3 required

ConflictingResourcesErrorResponse

object

Represents a standard Humanitec Error with additional details which describe why an action on a specific resource cannot be performed due to some other entitie…

3 properties 3 required

ResourceDefinitionResponse

object

A Resource Definitions describes how and when a resource should be provisioned. It links a driver (the how) along with a Matching Criteria (the when) to a Reso…

16 properties 10 required

HumanitecErrorResponse

object

HumanitecError represents a standard Humanitec Error

3 properties 2 required

ProvisionDependenciesResponse

object

ProvisionDependencies defines resources which are needed to be co-provisioned with the current resource.

3 properties 1 required

ConflictingResourcesErrorResponseDetailsResources

object

2 properties

CheckResourceAccountData

object

The successful check response details.

2 properties 1 required

CreateResourceAccountRequestRequest

object

CreateResourceAccountRequest describes the request to create a new security account.

4 properties 4 required

MatchingCriteriaResponse

object

Matching Criteria are a set of rules used to choose which Resource Definition to use to provision a particular Resource Type. Matching criteria are made up in…

6 properties 2 required

UpdateResourceAccountRequestRequest

object

UpdateResourceAccountRequest describes the request to update the security account details.

2 properties

ValuesSecretsRefsResponse

object

ValuesSecretsRefs stores data that should be passed around split by sensitivity.

3 properties

ResourceAccountResponse

object

ResourceAccount represents the account being used to access a resource. Resource Accounts hold credentials that are required to provision and manage resources.

6 properties 6 required

ConflictingResourcesErrorResponseDetails

object

Object composed by the list of resources which prevent the deletion of the specified entity. The resources are indexed by their kind.

1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Humanitec publishes across the network.

Humanitec AccountType API

AE Profile APIs.io

Humanitec ActiveResource API

AE Profile APIs.io

Humanitec Agents API

AE Profile APIs.io

Humanitec Application API

AE Profile APIs.io

Humanitec Artefact API

AE Profile APIs.io

Humanitec ArtefactVersion API

AE Profile APIs.io

Humanitec AuditLogs API

AE Profile APIs.io

Humanitec AutomationRule API

AE Profile APIs.io

Humanitec Delta API

AE Profile APIs.io

Humanitec Deployment API

AE Profile APIs.io

Humanitec DriverDefinition API

AE Profile APIs.io

Humanitec Environment API

AE Profile APIs.io

#ResourceAccount

← Back to H APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Humanitec ResourceAccount API

Metadata

Paths & Operations 6

Schemas 14

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Humanitec ResourceAccount API

Metadata

Paths & Operations 6

Schemas 14

Specification

Source

More from Humanitec 12

API Details

Provider

Explore more