Workspaces API

Preview

List instance groups

GET

/workspace/orgs/{org_id}/members/groups

Preview API

This API functionality is currently in preview. Preview APIs may be unstable within the preview period: they may change without notice. You must set the header API-Preview: opt-in to opt into using this functionality.

Returns a list of instance groups for the Evo instance along with their members and roles

Request

Request headers

authorizationstring

Required

API-Previewstring | null

Set to "opt-in" to be able to use this API.

Preview-APIstring | null

Set to "opt-in" to be able to use this API. This header is being deprecated. Please use the API-Preview header.

Path parameters

org_iduuid

Required

Responses

200

Successful Response

Response schema

groupsBaseInstanceGroupWithRolesResponse[]

descriptionstring

iduuid

ims_groupsstring[]

membersBaseInstanceUserResponse[]

emailstring

full_namestring

iduuid

namestring

rolesRbacGroupRole[]

descriptionstring

iduuid

namestring

Example response

{
  "groups": [
    {
      "description": "string",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "ims_groups": [
        "string"
      ],
      "members": [
        {
          "email": "string",
          "full_name": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "name": "string",
      "roles": [
        {
          "description": "string",
          "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "name": "string"
        }
      ]
    }
  ]
}

401

No permission -- see authorization schemes

Response schema

detailstring | null

invalid-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

403

Request forbidden -- authorization will not help

Response schema

detailstring | null

invalid-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

404

Resource not found or user lacks access

Response schema

detailstring | null

invalid-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

405

Specified method is invalid for this resource

Response schema

detailstring | null

invalid-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}

422

Unprocessable Content

Response schema

detailstring | null

invalid-paramsErrorInvalidParam[] | null

statusinteger

titlestring

typestring

Example response

{
  "detail": "string",
  "invalid-params": [
    {
      "name": "string",
      "reason": "string"
    }
  ],
  "status": 0,
  "title": "string",
  "type": "string"
}