Akter

Members

The people in an organization and their roles: owner, admin, developer or viewer.

List⁠

GEThttps://api.akter.dev/v1/organizations/{organization}/members
members.listBearer token

List an organization's members and their roles, a page at a time.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Query parameters

  • cursorstring

    The nextCursor of the previous page.

  • limitinteger

    At most this many items, 1 to 100. Defaults to 50.

Response 200MemberPage

  • itemsMember[]required
  • items[].emailstringrequired

    An email address, such as ada@example.com.

  • items[].idstringrequired

    An opaque id that starts with mem_.

  • items[].joinedAtstringrequired
  • items[].role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

  • nextCursorstring

    Pass as cursor for the next page.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Add⁠

POSThttps://api.akter.dev/v1/organizations/{organization}/members
members.addBearer token

Add a person to an organization by email, with a role.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

Request bodyAddMember

  • emailstringrequired

    An email address, such as ada@example.com.

  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Response 201Member

  • emailstringrequired

    An email address, such as ada@example.com.

  • idstringrequired

    An opaque id that starts with mem_.

  • joinedAtstringrequired
  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 409AlreadyExistsError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Change role⁠

PATCHhttps://api.akter.dev/v1/organizations/{organization}/members/{member}
members.changeRoleBearer tokenSafe to retry

Change a member's role. The Cloud API applies it at once; their actor calls get it with their next token, within a minute.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • memberstringrequired

    An opaque id that starts with mem_.

Request bodyChangeRole

  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Response 200Member

  • emailstringrequired

    An email address, such as ada@example.com.

  • idstringrequired

    An opaque id that starts with mem_.

  • joinedAtstringrequired
  • role"owner" | "admin" | "developer" | "viewer"required

    owner manages members and billing; admin manages apps and API keys; developer builds and deploys; viewer reads.

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError

Remove⁠

DELETEhttps://api.akter.dev/v1/organizations/{organization}/members/{member}
members.removeBearer token

Remove a member from an organization; they lose access to it. The Cloud API refuses them at once; a token they already hold still calls the organization's apps until it expires, at most a minute.

Path parameters

  • organizationstringrequired

    An organization's name, unique across Akter Cloud. 1 to 63 characters: a lowercase letter, then lowercase letters, digits or single hyphens, ending in a letter or digit.

  • memberstringrequired

    An opaque id that starts with mem_.

Response 204<No Content>

Errors

  • 401UnauthorizedError
  • 403ForbiddenError
  • 404NotFoundError | FeatureNotEnabledError
  • 428ConfirmationRequiredError
  • 503ActorUnavailableError | AuthUnavailableError | BillingUnavailableError | BuildStorageUnavailableError | ExecUnavailableError