Memberships

Manage with memberships which users have access to the resources your organisation owns.

List members inside an organisation.

Query Parameters:

  • pageable (Optional. When omitted: pageSize=50, pageNumber=0, sortDirection=ASC)
HTTP Responses codes for "List members inside an organisation."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

OrganisationMembershipResponse
  • email object
    One of #/components/schemas/Email
  • identity uuid
  • kubernetesRole string
  • memberIdentity uuid
  • name string
  • organisationIdentity uuid
  • role string
    One of admin developer billing-admin viewer
  • slug object
    One of #/components/schemas/Slug
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/memberships

Response

  • content array
    List of #/components/schemas/OrganisationMembershipResponse
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/OrganisationMembershipResponse"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "items": {
        "$ref": "#/components/schemas/SortObject"
      },
      "type": "array"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}

List members inside an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
HTTP Responses codes for "List members inside an environment."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.

Related Objects

EnvironmentMember
  • createdAt date-time
  • email string
  • kubernetesRole string
    One of cluster-admin edit view
  • memberIdentity uuid
PageableObject
  • offset int64
  • pageNumber int32
  • pageSize int32
  • paged boolean
  • sort array
    List of #/components/schemas/SortObject
  • unpaged boolean
SortObject
  • ascending boolean
  • direction string
  • ignoreCase boolean
  • nullHandling string
  • property string
GET /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/members

Response

  • content array
    List of #/components/schemas/EnvironmentMember
  • empty boolean
  • first boolean
  • last boolean
  • number int32
  • numberOfElements int32
  • pageable object
    One of #/components/schemas/PageableObject
  • size int32
  • sort array
    List of #/components/schemas/SortObject
  • totalElements int64
  • totalPages int32
                
{
  "properties": {
    "content": {
      "items": {
        "$ref": "#/components/schemas/EnvironmentMember"
      },
      "type": "array"
    },
    "empty": {
      "type": "boolean"
    },
    "first": {
      "type": "boolean"
    },
    "last": {
      "type": "boolean"
    },
    "number": {
      "format": "int32",
      "type": "integer"
    },
    "numberOfElements": {
      "format": "int32",
      "type": "integer"
    },
    "pageable": {
      "$ref": "#/components/schemas/PageableObject"
    },
    "size": {
      "format": "int32",
      "type": "integer"
    },
    "sort": {
      "items": {
        "$ref": "#/components/schemas/SortObject"
      },
      "type": "array"
    },
    "totalElements": {
      "format": "int64",
      "type": "integer"
    },
    "totalPages": {
      "format": "int32",
      "type": "integer"
    }
  },
  "type": "object"
}

Delete a member from an environment (member environment access will revert to organisation member access).

Path Parameters:

  • organisationSlug
  • environmentSlug
  • memberIdentity (The organisation member identity of the user.)
HTTP Responses codes for "Delete a member from an environment (member environment access will revert to organisation member access)."
Status CodeDescription
204Request was successfully processed, but there is no response body to return.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
DELETE /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/members/{memberIdentity}

Response

    No Content

Add or update a members inside an environment.

Path Parameters:

  • organisationSlug
  • environmentSlug
  • memberIdentity (The organisation member identity of the user.)
HTTP Responses codes for "Add or update a members inside an environment."
Status CodeDescription
200Request was successfully processed. The response body contains the requested data.
400Invalid request parameters. Please review the documentation for valid parameter values.
403You do not have the necessary permissions to access this resource.
404The requested resource could not be found. Please check the resource URL or identifier.
500An internal error occurred on the server.
Request Body Parameters
  • kubernetesRole string Required
    One of cluster-admin edit view
POST /api/v1/orgs/{organisationSlug}/environments/{environmentSlug}/members/{memberIdentity}

Response

    No Content

                
{
  "items": {
    "$ref": "#/components/schemas/EnvironmentMember"
  },
  "type": "array"
}
ScheduledUpgrades →