Firebolt Iam.v2.account Members API
The iam.v2.accountMembers API from Firebolt — 8 operation(s) for iam.v2.accountmembers.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/firebolt:firebolt-iam-v2-accountmembers-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Firebolt Iam.v2.account Members API
version: 1.0.0
x-logo:
altText: Firebolt
backgroundColor: '#FFFFFF'
url: https://assets.website-files.com/5e8a264ceaf4870394477fc7/5e8a264ceaf4879f75477fdd_logo_website.svg
tags:
- name: iam.v2.accountMembers
x-displayName: Account Members
paths:
/iam/v2/account/accountMember:
get:
tags:
- iam.v2.accountMembers
summary: Retrieves account member by it's ID
operationId: iamV2GetAccountMember
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.GetAccountMemberResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
delete:
tags:
- iam.v2.accountMembers
summary: Deletes account membership record
operationId: iamV2DeleteAccountMember
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.DeleteAccountMemberResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
/iam/v2/account/accountMember:acceptInvitation:
post:
description: This endpoint is used when existing user is invited to join an account (aka account sharing).
tags:
- iam.v2.accountMembers
summary: Accepts account member invitation
operationId: iamV2AcceptAccountMemberInvitation
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.AcceptAccountMemberInvitationResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.AcceptAccountMemberInvitationRequest'
required: true
/iam/v2/account/accountMember:approve:
post:
tags:
- iam.v2.accountMembers
summary: Approves account member by it's ID
operationId: iamV2ApproveAccountMember
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.ApproveAccountMemberResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
/iam/v2/account/accountMember:decline:
post:
tags:
- iam.v2.accountMembers
summary: Declines account member by it's ID
operationId: iamV2DeclineAccountMember
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.DeclineAccountMemberResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
/iam/v2/account/accountMember:resubmit:
post:
tags:
- iam.v2.accountMembers
summary: Generates new token for invitee and sends email with it
operationId: iamV2ResubmitAccountMember
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.ResubmitAccountMemberResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
/iam/v2/account/accountMembers:
get:
tags:
- iam.v2.accountMembers
summary: Returns a list of account members
operationId: iamV2ListAccountMembers
parameters:
- description: 'When `before` is provided, the last item returned in the paginated data will be the item that is closest to,
but still before, the cursor in the unpaginated results list. (Analogous to the above, if there are no items in the
results list that fall before the cursor, the returned paginated data will be an empty array.).'
name: page.before
in: query
schema:
type: string
- description: 'The `first` parameter indicates the number of results that the client would like to see in the response when
`after` is set or neither `after` or `before` is set.
Default: 25.'
name: page.first
in: query
schema:
type: integer
format: int32
- description: 'When `after` is provided, the returned paginated data will have as its first item the item that is
immediately after the cursor in the results list. (An exception is that, if there are no items in the results list
that fall after the cursor, the returned paginated data will be an empty array.).'
name: page.after
in: query
schema:
type: string
- description: 'The `last` parameter indicates the number of results that the client would like to see in the response
when `before` is set.
Default: 25.'
name: page.last
in: query
schema:
type: integer
format: int32
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.ListAccountMembersResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
post:
tags:
- iam.v2.accountMembers
summary: Creates a new account member record
operationId: iamV2CreateAccountMember
responses:
'200':
description: Created record.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.CreateAccountMemberRequest'
required: true
/iam/v2/accountMembers:acceptInvitation:
post:
description: 'This method is an alternative to `AcceptAccountMemberInvitation`
that does not require to specify `account_id` and `user_id`.'
tags:
- iam.v2.accountMembers
summary: Accepts account member invitation by token
operationId: iamV2AcceptAccountMemberInvitationByToken
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.AcceptAccountMemberInvitationByTokenResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.AcceptAccountMemberInvitationByTokenRequest'
required: true
/iam/v2/user/accountMembers:
get:
tags:
- iam.v2.accountMembers
summary: Returns a list of account memberships for a user
operationId: iamV2ListUserAccountMembers
parameters:
- description: 'When `before` is provided, the last item returned in the paginated data will be the item that is closest to,
but still before, the cursor in the unpaginated results list. (Analogous to the above, if there are no items in the
results list that fall before the cursor, the returned paginated data will be an empty array.).'
name: page.before
in: query
schema:
type: string
- description: 'The `first` parameter indicates the number of results that the client would like to see in the response when
`after` is set or neither `after` or `before` is set.
Default: 25.'
name: page.first
in: query
schema:
type: integer
format: int32
- description: 'When `after` is provided, the returned paginated data will have as its first item the item that is
immediately after the cursor in the results list. (An exception is that, if there are no items in the results list
that fall after the cursor, the returned paginated data will be an empty array.).'
name: page.after
in: query
schema:
type: string
- description: 'The `last` parameter indicates the number of results that the client would like to see in the response
when `before` is set.
Default: 25.'
name: page.last
in: query
schema:
type: integer
format: int32
responses:
'200':
description: A successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/firebolt.iam.v2.ListUserAccountMembersResponse'
default:
description: An unexpected error response
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
components:
schemas:
grpc.gateway.runtime.Error:
type: object
properties:
code:
type: integer
format: int32
details:
type: array
items:
$ref: '#/components/schemas/google.protobuf.Any'
error:
type: string
message:
type: string
firebolt.iam.v2.ListUserAccountMembersResponse:
type: object
properties:
edges:
description: List of found records.
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.AccountMemberEdge'
page:
description: Page descriptor.
$ref: '#/components/schemas/firebolt.shared.v1.PageDescriptor'
firebolt.iam.v2.AcceptAccountMemberInvitationByTokenResponse:
type: object
properties:
account_member:
description: Retrieved record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.AccountMemberJoinFlow:
description: "AccountMemberJoinFlow represents the flow that is used to add member to account.\n\n - ACCOUNT_MEMBER_JOIN_FLOW_INVITATION: Membership record created via invitation.\n - ACCOUNT_MEMBER_JOIN_FLOW_APPROVAL: Membership record created from user registration process by admin approval.\n - ACCOUNT_MEMBER_JOIN_FLOW_FIRST_REGISTRATION: Membership record created from user registration process first account user is automatically an admin."
type: string
default: ACCOUNT_MEMBER_JOIN_FLOW_UNSPECIFIED
enum:
- ACCOUNT_MEMBER_JOIN_FLOW_UNSPECIFIED
- ACCOUNT_MEMBER_JOIN_FLOW_INVITATION
- ACCOUNT_MEMBER_JOIN_FLOW_APPROVAL
- ACCOUNT_MEMBER_JOIN_FLOW_FIRST_REGISTRATION
firebolt.iam.v2.AcceptAccountMemberInvitationByTokenRequest:
type: object
properties:
token:
description: Required. Token value.
type: string
minLength: 1
firebolt.iam.v2.PolicyAssignmentConditionMatcherNot:
description: PolicyAssignmentConditionMatcherNot negates the result of the child condition.
type: object
properties:
condition:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentCondition'
firebolt.iam.v2.PolicyAssignmentConditionMatcherCIDR:
description: PolicyAssignmentConditionMatcherCIDR checks that metadata key is an IP address in given CIDR range.
type: object
properties:
cidr:
type: string
key:
type: string
firebolt.iam.v2.GetAccountMemberResponse:
type: object
properties:
account_member:
description: Retrieved record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.AccountMemberID:
description: AccountMemberID represents unique identifier of the record.
type: object
properties:
account_id:
description: Required. ID of the account this record belongs to.
type: string
user_id:
description: Required. ID of the user this record belongs to.
type: string
firebolt.shared.v1.PageDescriptor:
description: PageDescriptor represents pagination information in collection response.
type: object
properties:
has_next_page:
description: Whether next page is available.
type: boolean
format: boolean
has_previous_page:
description: Whether previous page is available.
type: boolean
format: boolean
page_size:
description: Number of items returned at this page.
type: integer
format: int64
total_size:
description: Total number of items matching the query.
type: integer
format: int64
firebolt.iam.v2.ResubmitAccountMemberResponse:
type: object
properties:
account_member:
description: Updated record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.ApproveAccountMemberResponse:
type: object
properties:
account_member:
description: Updated record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.AccountMemberStatus:
description: "AccountMemberStatus specifies the current status of membership record.\n\n - ACCOUNT_MEMBER_STATUS_CREATED: Membership record created, pending approval.\n - ACCOUNT_MEMBER_STATUS_ACCEPTED: Recipient accepted invitation.\n - ACCOUNT_MEMBER_STATUS_REJECTED: Recipient rejected invitation.\n - ACCOUNT_MEMBER_STATUS_CANCELED: Cancelled by sender."
type: string
default: ACCOUNT_MEMBER_STATUS_UNSPECIFIED
enum:
- ACCOUNT_MEMBER_STATUS_UNSPECIFIED
- ACCOUNT_MEMBER_STATUS_CREATED
- ACCOUNT_MEMBER_STATUS_ACCEPTED
- ACCOUNT_MEMBER_STATUS_REJECTED
- ACCOUNT_MEMBER_STATUS_CANCELED
firebolt.iam.v2.AccountMember:
description: 'AccountMember represents a user that has access to the account.
It is important to note that this entity is not used in access enforcement, Policy is used instead.
This entity only stores some metadata regarding User <-> Account connection and can be used for faster lookups.'
type: object
properties:
create_actor:
description: Output only. Resource name of the actor who created this record.
type: string
readOnly: true
create_time:
description: Output only. Time when this record was created.
type: string
format: date-time
readOnly: true
id:
description: Output only. Unique record ID.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMemberID'
readOnly: true
join_flow:
description: Output only. Flow that is used to add member to account.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMemberJoinFlow'
readOnly: true
last_update_actor:
description: Output only. Resource name of the actor who last updated this record.
type: string
readOnly: true
last_update_time:
description: Output only. Time when this record was last updated.
type: string
format: date-time
readOnly: true
reviewer_user_id:
description: Output only. ID of the user that invited/approved this member.
type: string
readOnly: true
status:
description: Output only. Status of this member.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMemberStatus'
readOnly: true
firebolt.iam.v2.AccountMemberEdge:
description: AccountMemberEdge represents a single record in paginated list.
type: object
properties:
cursor:
description: Pagination cursor for this node.
type: string
node:
description: Node instance.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.PolicyAssignmentCondition:
description: 'PolicyAssignmentCondition represents a conditional logic that enables or disables the policy assignment on
per-request basis.
Every authorization request may include additional metadata in form of key-value pairs.
This metadata is available in condition matchers, that are, effectively,
just a simple functions that return true or false.
Different matchers can be combined with help of OR/AND groups, allowing policy authors to express complex logic.'
type: object
properties:
and:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentConditionMatcherAnd'
cidr:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentConditionMatcherCIDR'
deny_message:
description: custom error message that will be returned to user if this condition will result access denial.
type: string
equal:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentConditionMatcherEqual'
not:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentConditionMatcherNot'
or:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentConditionMatcherOr'
firebolt.iam.v2.PolicyAssignmentConditionMatcherAnd:
description: PolicyAssignmentConditionMatcherAnd groups multiple child conditions with logical AND.
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentCondition'
firebolt.iam.v2.PolicyAssignment:
description: 'PolicyAssignment combines effect, permissions and condition when this assignment is enabled.
Single policy can have multiple assignments that grant or revoke permission based on condition.'
type: object
properties:
condition:
description: Condition when this assignment should apply.
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentCondition'
effect:
description: 'Effect of this assignment.
Whether to allow or deny access to resources.'
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentEffect'
permission_names:
description: 'Additional individual permission names to assign.
During policy evaluation, this permissions will be merged with permissions that are provided by roles.'
type: array
items:
type: string
role_ids:
description: IDs of roles to assign.
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.RoleID'
firebolt.iam.v2.PolicyAssignmentConditionMatcherOr:
description: PolicyAssignmentConditionMatcherOr groups multiple child conditions with logical OR.
type: object
properties:
conditions:
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignmentCondition'
firebolt.iam.v2.RoleID:
description: RoleID represents unique identifier of the record.
type: object
properties:
account_id:
description: 'ID of the account this record belongs to.
Empty value means "system".'
type: string
role_id:
description: Required. Unique record ID.
type: string
firebolt.iam.v2.CreateAccountMemberRequest:
type: object
properties:
access_roles:
type: array
title: List of roles to be granted in the new Access service (Firenze)
items:
type: string
assignments:
description: List of permissions to assign to this member.
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.PolicyAssignment'
invitation_type:
description: Template to use for invitation email.
type: string
invitee_email_address:
description: Email address of the user to invite.
type: string
firebolt.iam.v2.DeleteAccountMemberResponse:
type: object
properties:
account_member:
description: Updated record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.AcceptAccountMemberInvitationRequest:
type: object
properties:
token:
description: Required. Token value.
type: string
minLength: 1
firebolt.iam.v2.AcceptAccountMemberInvitationResponse:
type: object
properties:
account_member:
description: Retrieved record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
firebolt.iam.v2.PolicyAssignmentEffect:
description: "PolicyAssignmentEffect controls whether to allow or deny access to resources.\n\n - POLICY_ASSIGNMENT_EFFECT_ALLOW: Allow access to resources.\n - POLICY_ASSIGNMENT_EFFECT_DENY: Deny access to resources."
type: string
default: POLICY_ASSIGNMENT_EFFECT_UNSPECIFIED
enum:
- POLICY_ASSIGNMENT_EFFECT_UNSPECIFIED
- POLICY_ASSIGNMENT_EFFECT_ALLOW
- POLICY_ASSIGNMENT_EFFECT_DENY
firebolt.iam.v2.ListAccountMembersResponse:
type: object
properties:
edges:
description: List of found records.
type: array
items:
$ref: '#/components/schemas/firebolt.iam.v2.AccountMemberEdge'
page:
description: Page descriptor.
$ref: '#/components/schemas/firebolt.shared.v1.PageDescriptor'
firebolt.iam.v2.PolicyAssignmentConditionMatcherEqual:
description: PolicyAssignmentConditionMatcherEqual checks that metadata key equals some value.
type: object
properties:
equal:
type: string
key:
type: string
google.protobuf.Any:
description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := ptypes.MarshalAny(foo)\n ...\n foo := &pb.Foo{}\n if err := ptypes.UnmarshalAny(any, foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
type: object
properties:
type_url:
description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
type: string
value:
description: Must be a valid serialized protocol buffer of the above specified type.
type: string
format: byte
firebolt.iam.v2.DeclineAccountMemberResponse:
type: object
properties:
account_member:
description: Updated record.
$ref: '#/components/schemas/firebolt.iam.v2.AccountMember'
x-tagGroups:
- name: Getting Started
tags:
- auth.v1
- name: Identity & Access Management
tags:
- iam.v2.roles
- iam.v2.permissions
- iam.v2.policies
- iam.v2.databaseGrants
- iam.v2.accounts
- iam.v2.users
- iam.v2.accountMembers
- iam.v2.serviceAccounts
- iam.v2.actors
- name: Cloud Providers
tags:
- aws.v2.marketplace
- name: Compute Resources
tags:
- compute.v1.instanceTypes
- compute.v1.regions
- compute.v1.providers
- name: Databases & Engines
tags:
- core.v1.databases
- core.v1.engines
- core.v1.engineRevisions
- core.v1.bindings
- name: SQL Editor
tags:
- editor.v1.scripts
x-provenance:
method: harvested
publisher: Firebolt
source: https://api.app.firebolt.io/docs/openapi.json
note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
stamped by stamp-openapi-provenance.py (roadmap#793)