Groups

List IMS groups

Workspaces API

Version: 1.0

Preview

Returns IMS groups available for this instance. External users and instances without directory access receive 403 ims-directory-access-restricted.

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.

Parameters

authorizationstring

Required

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

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

org_iduuid

Required

Returns

200

Successful Response

idstring

is_federated_groupboolean

namestring

Endpoint

GET

/workspace/orgs/{org_id}/ims/groups

Request

cURL

​

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/ims/groups' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

[
  {
    "id": "string",
    "is_federated_group": true,
    "name": "string"
  }
]

---

Get IMS group details

Workspaces API

Version: 1.0

Preview

Returns details of an IMS group available for this instance. External users and instances without directory access receive 403 ims-directory-access-restricted.

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.

Parameters

authorizationstring

Required

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

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

group_iduuid

Required

org_iduuid

Required

Returns

200

Successful Response

descriptionstring

iduuid

is_federated_groupboolean

namestring

Endpoint

GET

/workspace/orgs/{org_id}/ims/groups/{group_id}

Request

cURL

​

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/ims/groups/{group_id}' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "description": "string",
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "is_federated_group": true,
  "name": "string"
}

---

List IMS group members

Workspaces API

Version: 1.0

Preview

Returns members of an IMS group available for this instance. External users and instances without directory access receive 403 ims-directory-access-restricted.

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.

Parameters

authorizationstring

Required

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

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

group_iduuid

Required

org_iduuid

Required

Returns

200

Successful Response

emailstring

full_namestring

Endpoint

GET

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

Request

cURL

​

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/ims/groups/{group_id}/members' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "users": [
    {
      "email": "string",
      "full_name": "string"
    }
  ]
}

---

Get IMS users

Workspaces API

Version: 1.0

Returns users in the instance's organization, filtered by the first characters of their email address. External users and instances without directory access receive 403 ims-directory-access-restricted.

Parameters

authorizationstring

Required

org_iduuid

Required

emailstring

Required

≥ 9 chars

Example: "ilike:foo*"

Returns

200

Successful Response

emailstring

full_namestring

Endpoint

GET

/workspace/orgs/{org_id}/ims/users

Request

cURL

​

curl -X GET 'https://{service_host}/workspace/orgs/{org_id}/ims/users' \
  -H 'Authorization: Bearer <ACCESS_TOKEN>'

Response

{
  "users": [
    {
      "email": "string",
      "full_name": "string"
    }
  ]
}