Acquisition complete HashiCorp officially joins the IBM family. Learn more
HashiCorp Cloud Platform

HashiCorp Resource Manager Service

stable

API for managing organizations, projects, and listing resources within projects.

Download Spec

Operations

​Get​Iam​Policy

get

​/​resource-manager​/​resources​/​iam-policy

​Get​Iam​Policy

https://api.cloud.hashicorp.com/2019-12-10/resource-manager/resources/iam-policy

Request

Query Parameters
resource_namestring

ResourceName is the resource name of the resource. Either this or the ResourceId needs to be provided.

resource_idstring

ResourceId is the resource name of the resource. Either this or the ResourceName needs to be provided.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Iam​Policy

put

​/​resource-manager​/​resources​/​iam-policy

​Set​Iam​Policy

https://api.cloud.hashicorp.com/2019-12-10/resource-manager/resources/iam-policy

Request

Body Parameters
resource_namestring

ResourceName is the resource name of the resource. Either this or the ResourceId needs to be provided.

resource_idstring

ResourceId is the resource name of the resource. Either this or the ResourceName needs to be provided.

policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Resource

get

​/​resource-manager​/​resource

​Get​Resource

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/resource

Request

Query Parameters
resource_idstring

ResourceId is the unique identifier of the resource.

resource_namestring

ResourceName is the name of the resource.

Response

200 - OK
resource_idstring

ResourceId is the ID of the registered resource.

resource_namestring

ResourceName is the name of the registered resource.

resource_typestring

ResourceType is the type of the registered resource.

parent_idstring

ParentId is the ID of the parent of the registered resource.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Roles

get

​/​resource-manager​/​resource​/​roles

​List​Roles

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/resource/roles

Request

Query Parameters
resource.namestring

Name is the resource name of the resource.

resource.idstring

Id is the resource id of the resource.

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
rolesobject[]

Role binds a name to a set of permissions.

  • idstring

    Builtin roles are prefixed with "roles/"

  • versioninteger

    Version is the instance of this role - version is incremented when a permission is added or removed and when other metadata is changed.

  • titlestring

    Title is a display name for this role.

  • descriptionstring

    Description provides information regarding the purpose of this role.

  • permissionsstring[]
  • lowest_applicable_resource_typesstring[]
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List

get

​/​resource-manager​/​resources

​List

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/resources

Request

Query Parameters
scope.typestring

ResourceType is the type of object being referenced.

scope.idstring

id is the id of the object being referenced.

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
resourcesobject[]
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • resource_namestring

    ResourceName is the name of the resource. This is only available on List responses and is not valid for any creation or update requests.

  • resource_idstring

    ResourceID is the ID of the resource. This is only available on List responses and is not valid for any creation or update requests.

  • geostring

    Geo is the geography where the resource is registered. A resource MAY NOT have a geography associated with it. The currently valid values are: "", "us", and "eu". This is only available on List responses and is not valid for any creation or update requests.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Accessible​Resources

get

​/​resource-manager​/​resources​/​accessible

​List​Accessible​Resources

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/resources/accessible

Request

Query Parameters
scope_resource_namestring

ScopeResourceName is resource name of the parent object to list resources under. Either this or the ResourceId needs to be provided.

scope_resource_idstring

ScopeResourceId is resource ID of the parent object to list resources under. Either this or the ResourceName needs to be provided.

resource_typestring

ResourceType is the resource type of the resources to list.

permissionstring

Permission is the permission to check.

leaf_name_filterstring

LeafNameFilter optionally allows for filtering results based on a substring match of the final/leaf name within the resource's resource name.

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
resourcesobject[]

ResourceV2 is a container for resource v2 identifiers.

  • resource_namestring

    ResourceName is the name of the resource.

  • resource_idstring

    ResourceID is the ID of the resource.

  • geostring

    Geo is the geography where the resource is registered. A resource MAY NOT have a geography associated with it. The currently valid values are: "", "us", and "eu".

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Test​Iam​Permissions

post

​/​resource-manager​/​resources​/​test-iam-permissions

​Test​Iam​Permissions

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/resources/test-iam-permissions

Request

Body Parameters
resourceobject
  • linkobject

    Link is used to uniquely reference any resource within HashiCorp Cloud. This can be conceptually considered a "foreign key".

    • typestring

      type is the unique type of the resource. Each service publishes a unique set of types. The type value is recommended to be formatted in "." such as "hashicorp.hvn". This is to prevent conflicts in the future, but any string value will work.

    • idstring

      id is the identifier for this resource.

    • uuidstring

      uuid is the unique UUID for this resource.

    • locationobject

      Location represents a target for an operation in HCP.

      • organization_idstring

        organization_id is the id of the organization.

      • project_idstring

        project_id is the projects id.

      • regionobject

        Region identifies a Cloud data-plane region.

        • providerstring
        • regionstring
    • descriptionstring

      description is a human-friendly description for this link. This is used primarily for informational purposes such as error messages.

  • resource_namestring

    ResourceName is the name of the resource. This is only available on List responses and is not valid for any creation or update requests.

  • resource_idstring

    ResourceID is the ID of the resource. This is only available on List responses and is not valid for any creation or update requests.

  • geostring

    Geo is the geography where the resource is registered. A resource MAY NOT have a geography associated with it. The currently valid values are: "", "us", and "eu". This is only available on List responses and is not valid for any creation or update requests.

permissionsstring[]

Response

200 - OK
allowed_permissionsstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Batch​Test​Iam​Permissions

post

​/​resource-manager​/​authorization​/​batch-test-iam-permissions

​Batch​Test​Iam​Permissions

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/authorization/batch-test-iam-permissions

Request

Body Parameters
resourcesobject[]

AuthorizationTestIamPermissionsRequest is a request to test a set of permissions.

  • permissionsstring[]
  • resource_idstring

    ResourceId holds the unique, immutable and non-reusable ID of the resource.

    Example formats include:

    • vault.cluster:t79BRg8WhTmDPBRM
    • vagrant.box:gTmD2KMMRt9DWhJz
  • resource_namestring

    ResourceName holds the Resource Name in the Resource Identifier v2 format. This parameter is expected to be provided only for external calls.

    Example formats include:

    • vault/project/e1e04e11-d590-41cf-b818-1535bc4b4889/cluster/my-cluster
    • vagrant/organization/ubuntu/box/lunar64/version/v20230130.0.0
    • iam/organization/zBmk8k7Pk99ph7Kr/service-principal/my-sp-43563412
    • consul/project/e57a01aa-1929-40e8-80b8-4907fc46429c/cluster/my-cluster

    In case of organization or project level authorization the ResourceName is expected to be provided in the following format:

    • organization/863063b6-c485-4cf4-8df3-6991a2ffd4b4
    • project/e1e04e11-d590-41cf-b818-1535bc4b4889
    • project/gTmD2KMMRt9DWhJz

Response

200 - OK
resource_permissionsobject

Request: [ { Permissions: [...], ResourceId: "abc123", ResourceName: "", }, { Permissions: [...], ResourceId: "", ResourceName: "iam/group/456" }, { Permissions: [...], ResourceId: "def789", ResourceName: "iam/group/789", }, ]

Response: { "abc123": { AllowedPermissions: [...] }, "iam/group/456": { AllowedPermissions: [...] }, "def789": { AllowedPermissions: [...] }, "iam/group/789": { AllowedPermissions: [...] }, }

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Test​Iam​Permissions

post

​/​resource-manager​/​authorization​/​test-iam-permissions

​Test​Iam​Permissions

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/authorization/test-iam-permissions

Request

Body Parameters
permissionsstring[]
resource_idstring

ResourceId holds the unique, immutable and non-reusable ID of the resource.

Example formats include:

  • vault.cluster:t79BRg8WhTmDPBRM
  • vagrant.box:gTmD2KMMRt9DWhJz
resource_namestring

ResourceName holds the Resource Name in the Resource Identifier v2 format. This parameter is expected to be provided only for external calls.

Example formats include:

  • vault/project/e1e04e11-d590-41cf-b818-1535bc4b4889/cluster/my-cluster
  • vagrant/organization/ubuntu/box/lunar64/version/v20230130.0.0
  • iam/organization/zBmk8k7Pk99ph7Kr/service-principal/my-sp-43563412
  • consul/project/e57a01aa-1929-40e8-80b8-4907fc46429c/cluster/my-cluster

In case of organization or project level authorization the ResourceName is expected to be provided in the following format:

  • organization/863063b6-c485-4cf4-8df3-6991a2ffd4b4
  • project/e1e04e11-d590-41cf-b818-1535bc4b4889
  • project/gTmD2KMMRt9DWhJz

Response

200 - OK
allowed_permissionsstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List

get

​/​resource-manager​/​organizations

​List

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations

Request

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
organizationsobject[]

Organization is the root node in the resource hierarchy. All resources for an entity reside under the organization.

  • idstring

    ID is an UUID identifying the Organization object.

  • namestring

    Name is the user settable name of the organization.

  • ownerobject

    OrganizationOwner identifies the user who owns the organization.

    • userstring

      User is the user principal id of the owner.

  • created_atstring

    CreatedAt is the time the organization was created at.

  • statestring

    OrganizationState is the states the organization can be in.

  • tfc_syncedboolean

    TfcSynced is true if this organization has synced to TFC.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get

get

​/​resource-manager​/​organizations​/​{id}

​Get

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}

Request

Path Parameters
idstringRequired

ID is the identifier of the organization to retrieve.

Response

200 - OK
organizationobject

Organization is the root node in the resource hierarchy. All resources for an entity reside under the organization.

  • idstring

    ID is an UUID identifying the Organization object.

  • namestring

    Name is the user settable name of the organization.

  • ownerobject

    OrganizationOwner identifies the user who owns the organization.

    • userstring

      User is the user principal id of the owner.

  • created_atstring

    CreatedAt is the time the organization was created at.

  • statestring

    OrganizationState is the states the organization can be in.

  • tfc_syncedboolean

    TfcSynced is true if this organization has synced to TFC.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Iam​Policy

get

​/​resource-manager​/​organizations​/​{id}​/​iam-policy

​Get​Iam​Policy

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/iam-policy

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Iam​Policy

put

​/​resource-manager​/​organizations​/​{id}​/​iam-policy

​Set​Iam​Policy

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/iam-policy

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

Body Parameters
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Name

put

​/​resource-manager​/​organizations​/​{id}​/​name

​Set​Name

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/name

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

Body Parameters
namestring

Name is the new name of the organization.

Response

200 - OK
organizationobject

Organization is the root node in the resource hierarchy. All resources for an entity reside under the organization.

  • idstring

    ID is an UUID identifying the Organization object.

  • namestring

    Name is the user settable name of the organization.

  • ownerobject

    OrganizationOwner identifies the user who owns the organization.

    • userstring

      User is the user principal id of the owner.

  • created_atstring

    CreatedAt is the time the organization was created at.

  • statestring

    OrganizationState is the states the organization can be in.

  • tfc_syncedboolean

    TfcSynced is true if this organization has synced to TFC.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List​Roles

get

​/​resource-manager​/​organizations​/​{id}​/​roles

​List​Roles

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/roles

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

Query Parameters
pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
rolesobject[]

Role binds a name to a set of permissions.

  • idstring

    Builtin roles are prefixed with "roles/"

  • versioninteger

    Version is the instance of this role - version is incremented when a permission is added or removed and when other metadata is changed.

  • titlestring

    Title is a display name for this role.

  • descriptionstring

    Description provides information regarding the purpose of this role.

  • permissionsstring[]
  • lowest_applicable_resource_typesstring[]
paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Test​Iam​Permissions

post

​/​resource-manager​/​organizations​/​{id}​/​test-iam-permissions

​Test​Iam​Permissions

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/test-iam-permissions

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

Body Parameters
permissionsstring[]

Response

200 - OK
allowed_permissionsstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Role

get

​/​resource-manager​/​organizations​/​{id}​/​{role_id}

​Get​Role

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/organizations/{id}/{role_id}

Request

Path Parameters
idstringRequired

ID is the identifier of the organization.

role_idstringRequired

RoleId is the identifier of the role to retrieve.

Response

200 - OK
roleobject

Role binds a name to a set of permissions.

  • idstring

    Builtin roles are prefixed with "roles/"

  • versioninteger

    Version is the instance of this role - version is incremented when a permission is added or removed and when other metadata is changed.

  • titlestring

    Title is a display name for this role.

  • descriptionstring

    Description provides information regarding the purpose of this role.

  • permissionsstring[]
  • lowest_applicable_resource_typesstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​List

get

​/​resource-manager​/​projects

​List

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects

Request

Query Parameters
scope.typestring

ResourceType is the type of object being referenced.

scope.idstring

id is the id of the object being referenced.

pagination.page_sizeinteger

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

Response

200 - OK
projectsobject[]

Project is a container for resources.

  • idstring

    ID is an UUID identifying the project object.

  • namestring

    Name is the user settable name of the project.

  • parentobject

    ResourceID is a reference to an object in the resource hierarchy.

    • typestring
    • idstring

      id is the id of the object being referenced.

  • created_atstring

    CreatedAt is the time the project was created at.

  • statestring

    ProjectState is the states the project can be in.

  • descriptionstring

    Description is the user settable description of the project.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Projects​Count

get

​/​resource-manager​/​projects​/​count

​Get​Projects​Count

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/count

Request

Query Parameters
scope.typestring

ResourceType is the type of object being referenced.

scope.idstring

id is the id of the object being referenced.

Response

200 - OK
countinteger

Count is the count of projects belonging to a parent scope.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get

get

​/​resource-manager​/​projects​/​{id}

​Get

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}

Request

Path Parameters
idstringRequired

ID is the identifier of the organization to retrieve.

Response

200 - OK
projectobject

Project is a container for resources.

  • idstring

    ID is an UUID identifying the project object.

  • namestring

    Name is the user settable name of the project.

  • parentobject

    ResourceID is a reference to an object in the resource hierarchy.

    • typestring
    • idstring

      id is the id of the object being referenced.

  • created_atstring

    CreatedAt is the time the project was created at.

  • statestring

    ProjectState is the states the project can be in.

  • descriptionstring

    Description is the user settable description of the project.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Description

put

​/​resource-manager​/​projects​/​{id}​/​description

​Set​Description

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}/description

Request

Path Parameters
idstringRequired

id is the identifier of the project to update.

Body Parameters
descriptionstring

description is the value the project's description should be updated to.

Response

200 - OK
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Get​Iam​Policy

get

​/​resource-manager​/​projects​/​{id}​/​iam-policy

​Get​Iam​Policy

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}/iam-policy

Request

Path Parameters
idstringRequired

ID is the identifier of the project.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Iam​Policy

put

​/​resource-manager​/​projects​/​{id}​/​iam-policy

​Set​Iam​Policy

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}/iam-policy

Request

Path Parameters
idstringRequired

ID is the identifier of the project.

Body Parameters
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Response

200 - OK
policyobject

An organization policy which has a single owner and many contributors.

"policy": { "bindings": [{ "role_id": "roles/owner", "members": [ { "member_type": "USER", "member_id": "f0b6f14c-ff6d-481a-8bd6-f4f0d356bc93" } ] }, { "role_id": "roles/contributor", "members": [ { "member_type": "USER", "member_id": "b24c10e6-7f2d-4660-a163-f54f52439080" }, { "member_type": "USER", "member_id": "b2becb8c-4947-4a29-94bb-c952b1b67f1e" }, { "member_type": "GROUP", "member_id": "356120ef-3014-404c-b574-c1c9e804663a" } ] }], "etag": "afd123" }

  • bindingsobject[]

    PolicyBinding binds a list of members to a role.

    • role_idstring
    • membersobject[]

      PolicyBindingMember represents an identity associated with a policy binding.

      • member_typestring

        PolicyBindingMemberType is the type of the policy binding member.

      • member_idstring

        MemberId is the unique identifier for the member.

  • etagstring

    Etag identifies this version of the policy.

Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Set​Name

put

​/​resource-manager​/​projects​/​{id}​/​name

​Set​Name

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}/name

Request

Path Parameters
idstringRequired

id is the identifier of the project to update.

Body Parameters
namestring

name is the value the project's name should be updated to.

Response

200 - OK
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.

​Test​Iam​Permissions

post

​/​resource-manager​/​projects​/​{id}​/​test-iam-permissions

​Test​Iam​Permissions

https://api.cloud.hashicorp.com/resource-manager/2019-12-10/projects/{id}/test-iam-permissions

Request

Path Parameters
idstringRequired

ID is the identifier of the project.

Body Parameters
permissionsstring[]

Response

200 - OK
allowed_permissionsstring[]
Default Error Response
codeinteger

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

messagestring

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

detailsobject[]

An arbitrary serialized message. Visit the protobufAny documentation for more information.

  • @typestring

    A URL that describes the type of the serialized message.