Link Search Menu Expand Document

Members

Members are users that belong to a particular workspace. Every member is derived from a corresponding profile, inheriting its id and name. Within the scope of a workspace, each member is visible to one another, so operating with a reduced property set allows for enhanced data security.


Objects

Member

Path Type Format Description
id String Version 4 UUID The member ID (derived from corresponding profile ID)
name String   The member name (derived from corresponding profile name)
handle String   The unique @-prefixed handle for this member (derived from corresponding profile handle)
{
  "id" : "auth0|5eb0327cbfd7490bff55feeb",
  "name" : "[email protected]",
  "handle" : "@support+integrationtests+a7o91bel",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}

Requests


View all members of a workspace

GET

/api/workspaces/{workspace-id}/members

Returns all members of the workspace {workspace-id}.

Prerequisites

  • The user must be a member of the workspace {workspace-id}

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Member collection with HAL links.

{
  "_embedded" : {
    "members" : [ {
      "id" : "auth0|5eb0327cbfd7490bff55feeb",
      "name" : "[email protected]",
      "handle" : "@support+integrationtests+a7o91bel",
      "_links" : {
        "self" : {
          "href" : "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members/auth0%7C5eb0327cbfd7490bff55feeb"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members"
    }
  }
}

View a member of a workspace

GET

/api/workspaces/{workspace-id}/members/{member-id}

Returns the member {member-id} of the workspace {workspace-id}.

Prerequisites

  • The user must be a member of the workspace {workspace-id}

Request

Example Snippets

  • cURL
curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members/auth0%7C5eb0327cbfd7490bff55feeb' -i -X GET \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'
  • Python (requests)
import requests

url = "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members/auth0%7C5eb0327cbfd7490bff55feeb"

headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("GET", url, headers=headers)

print(response.text.encode('utf8'))

Response

200 OK

Member with HAL links.

{
  "id" : "auth0|5eb0327cbfd7490bff55feeb",
  "name" : "[email protected]",
  "handle" : "@support+integrationtests+a7o91bel",
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/46d3d8d3-b3df-4777-8e8d-005735f85aaf/members/auth0%7C5eb0327cbfd7490bff55feeb"
    }
  }
}