Skip to main content Link Menu Expand (external link) Document Search Copy Copied

Invitations

Invitations allow access to private workspaces. When an invitation is created, an email containing an access link to the workspace will be sent to the recipient. Invitations can be sent to email addresses under the allowed domains configured for a workspace.

Objects

Invitation

Path Type Format Description
id String Version 4 UUID The invitation ID
created String ISO 8601 timestamp The instant the invitation was created
lastModified String ISO 8601 timestamp The instant the invitation was last modified
status String Invitation Status The invitation status
email String Email address The invitation target email address
creator Member   The invitation creator
workspace Workspace   The invitation target workspace 
{
  "_embedded" : {
    "invitations" : [ {
      "id" : "ef5fbfe2-db27-41c1-b57a-3246c4350ae8",
      "created" : "2024-04-10T14:08:20.009672",
      "lastModified" : "2024-04-10T14:08:20.009673",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ef5fbfe2-db27-41c1-b57a-3246c4350ae8",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ef5fbfe2-db27-41c1-b57a-3246c4350ae8/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "ba74659d-575d-4ccd-b730-494f9a1f6b13",
      "created" : "2024-04-10T14:08:12.251379",
      "lastModified" : "2024-04-10T14:08:12.251379",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "31ced07c-4967-401c-ad5b-e1950ff40181",
      "created" : "2024-04-10T14:08:12.542757",
      "lastModified" : "2024-04-10T14:08:12.542758",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "c5c50dbd-b885-4172-932d-0fa8a24be24a",
      "created" : "2024-04-10T14:08:07.774479",
      "lastModified" : "2024-04-10T14:08:07.77448",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "2e31f701-eaa7-49c3-b754-82e0db6f2fda",
      "created" : "2024-04-10T14:08:12.395025",
      "lastModified" : "2024-04-10T14:08:12.395025",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda/revoked",
          "type" : "PUT"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Formats

Invitation Status

String

Value Description
ACCEPTED The invitation has been accepted by the recipient
PENDING The invitation has been sent to the recipient and is awaiting acceptance
REVOKED The invitation has been revoked and can no longer be accepted

Requests

View all sent invitations

GET

/api/invitations

Returns all invitations sent by the authenticated user profile.

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/invitations' -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:443/api/invitations"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Invitation collection with HAL links.

{
  "_embedded" : {
    "invitations" : [ {
      "id" : "ba74659d-575d-4ccd-b730-494f9a1f6b13",
      "created" : "2024-04-10T14:08:12.251379",
      "lastModified" : "2024-04-10T14:08:12.251379",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "31ced07c-4967-401c-ad5b-e1950ff40181",
      "created" : "2024-04-10T14:08:12.542757",
      "lastModified" : "2024-04-10T14:08:12.542758",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "c5c50dbd-b885-4172-932d-0fa8a24be24a",
      "created" : "2024-04-10T14:08:07.774479",
      "lastModified" : "2024-04-10T14:08:07.77448",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "2e31f701-eaa7-49c3-b754-82e0db6f2fda",
      "created" : "2024-04-10T14:08:12.395025",
      "lastModified" : "2024-04-10T14:08:12.395025",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda/revoked",
          "type" : "PUT"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/invitations{?email}",
      "templated" : true
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 4,
    "totalPages" : 1,
    "number" : 0
  }
}

View all received invitations

GET

/api/invitations?email={user-email}

Returns all invitations received by the authenticated user profile.

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/invitations?email=sit%2Bprod%2B2%40matatika.com' -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:443/api/invitations?email=sit%2Bprod%2B2%40matatika.com"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Invitation collection with HAL links.

{
  "_embedded" : {
    "invitations" : [ {
      "id" : "5ae37cff-587b-4674-8c13-533108be341b",
      "created" : "2024-04-10T14:08:15.639485",
      "lastModified" : "2024-04-10T14:08:15.639485",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "198e93e2-a24d-40af-9915-72e68b3c2ba8",
        "created" : "2024-04-10T14:08:15.125296",
        "lastModified" : "2024-04-10T14:08:15.125296",
        "alias" : "glcgjem",
        "name" : "SIT-Generated Workspace [2024-04-10T15:08:15.026711]",
        "repositoryUrl" : "https://github.com/MatatikaBytes/SIT-Generated-Workspace-2024-04-10T15-08-15-026711--glcgjem",
        "repositoryBranch" : "main",
        "deploymentSecret" : "ztklnweveznrdvvllgfyedlewgxdoh",
        "appProperties" : { },
        "status" : "PROVISIONING",
        "managed" : true
      },
      "_links" : {
        "accept invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/5ae37cff-587b-4674-8c13-533108be341b",
          "type" : "PATCH"
        }
      }
    }, {
      "id" : "680f201b-b794-4e05-8ed1-e8b9e3f803f3",
      "created" : "2024-04-10T14:08:13.499843",
      "lastModified" : "2024-04-10T14:08:13.499843",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "a17a557f-f6d2-4115-b4d7-b18e7eaf2d02",
        "created" : "2024-04-10T14:08:12.993992",
        "lastModified" : "2024-04-10T14:08:12.993992",
        "alias" : "yvhcfvj",
        "name" : "SIT-Generated Workspace [2024-04-10T15:08:12.907134]",
        "repositoryUrl" : "https://github.com/MatatikaBytes/SIT-Generated-Workspace-2024-04-10T15-08-12-907134--yvhcfvj",
        "repositoryBranch" : "main",
        "deploymentSecret" : "qijfpirnbsoliwfeggbildkghyeuya",
        "appProperties" : { },
        "status" : "PROVISIONING",
        "managed" : true
      },
      "_links" : {
        "accept invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/680f201b-b794-4e05-8ed1-e8b9e3f803f3",
          "type" : "PATCH"
        }
      }
    }, {
      "id" : "907791e5-3f0c-4351-ac72-23295659b3a7",
      "created" : "2024-04-10T14:08:17.740425",
      "lastModified" : "2024-04-10T14:08:17.740426",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "742dde84-8d2b-46e8-a60c-9d05aecc3bd6",
        "created" : "2024-04-10T14:08:17.219383",
        "lastModified" : "2024-04-10T14:08:17.219383",
        "alias" : "bqcuigx",
        "name" : "SIT-Generated Workspace [2024-04-10T15:08:17.128200]",
        "repositoryUrl" : "https://github.com/MatatikaBytes/SIT-Generated-Workspace-2024-04-10T15-08-17-128200--bqcuigx",
        "repositoryBranch" : "main",
        "deploymentSecret" : "ivmbujlhufebtpwukegpbxxsusqfcl",
        "appProperties" : { },
        "status" : "PROVISIONING",
        "managed" : true
      },
      "_links" : {
        "accept invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/907791e5-3f0c-4351-ac72-23295659b3a7",
          "type" : "PATCH"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/[email protected]"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 3,
    "totalPages" : 1,
    "number" : 0
  }
}

View all invitations to a workspace

GET

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

As a workspace owner…

Returns all active invitations to the workspace {workspace-id}.

As a workspace member…

Returns all active invitations to the workspace {workspace-id} sent by the authenticated user profile.

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:443/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations' -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:443/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Invitation collection with HAL links.

{
  "_embedded" : {
    "invitations" : [ {
      "id" : "ef5fbfe2-db27-41c1-b57a-3246c4350ae8",
      "created" : "2024-04-10T14:08:20.009672",
      "lastModified" : "2024-04-10T14:08:20.009673",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ef5fbfe2-db27-41c1-b57a-3246c4350ae8",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ef5fbfe2-db27-41c1-b57a-3246c4350ae8/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "ba74659d-575d-4ccd-b730-494f9a1f6b13",
      "created" : "2024-04-10T14:08:12.251379",
      "lastModified" : "2024-04-10T14:08:12.251379",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/ba74659d-575d-4ccd-b730-494f9a1f6b13/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "31ced07c-4967-401c-ad5b-e1950ff40181",
      "created" : "2024-04-10T14:08:12.542757",
      "lastModified" : "2024-04-10T14:08:12.542758",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/31ced07c-4967-401c-ad5b-e1950ff40181/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "c5c50dbd-b885-4172-932d-0fa8a24be24a",
      "created" : "2024-04-10T14:08:07.774479",
      "lastModified" : "2024-04-10T14:08:07.77448",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/c5c50dbd-b885-4172-932d-0fa8a24be24a/revoked",
          "type" : "PUT"
        }
      }
    }, {
      "id" : "2e31f701-eaa7-49c3-b754-82e0db6f2fda",
      "created" : "2024-04-10T14:08:12.395025",
      "lastModified" : "2024-04-10T14:08:12.395025",
      "status" : "PENDING",
      "email" : "[email protected]",
      "creator" : {
        "id" : "auth0|5eb0327cbfd7490bff55feeb",
        "name" : "[email protected]",
        "handle" : "@sit+prod"
      },
      "workspace" : {
        "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
        "created" : "2024-04-10T14:08:06.893592",
        "lastModified" : "2024-04-10T14:08:06.893592",
        "alias" : "pyugnho",
        "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
        "repositoryUrl" : "DISABLED",
        "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
        "appProperties" : { },
        "status" : "READY",
        "managed" : true
      },
      "_links" : {
        "delete invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda",
          "type" : "DELETE"
        },
        "withdraw invitation" : {
          "href" : "https://catalog.matatika.com/api/invitations/2e31f701-eaa7-49c3-b754-82e0db6f2fda/revoked",
          "type" : "PUT"
        }
      }
    } ]
  },
  "_links" : {
    "self" : {
      "href" : "https://catalog.matatika.com/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations?page=0&size=20"
    }
  },
  "page" : {
    "size" : 20,
    "totalElements" : 5,
    "totalPages" : 1,
    "number" : 0
  }
}

Create an invitation to a workspace

POST

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

Creates an invitation to the workspace {workspace-id}.

Prerequisites

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

Request

Body

Invitation resource.

{
  "email" : "[email protected]"
}

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations' -i -X POST \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/hal+json; charset=ISO-8859-1' \
    -d '{
  "email" : "[email protected]"
}'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/workspaces/67694fbd-f150-48ae-a3d4-ae68f5b2390f/invitations"

data = {
  "email" : "[email protected]"
}
headers = {
  'Authorization': ACCESS_TOKEN
}

response = requests.request("POST", url, headers=headers, data=data)

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

Response

202 Accepted

No response body provided.

Accept an invitation

PATCH

/api/invitations/{invitation-id}

Accepts the invitation {invitation-id}.

Prerequisites

  • Workspace {workspace-id} must exist
  • Invitation {invitation-id} must exist for the authenticated user profile

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/invitations/d589323e-143c-44fc-ad03-c4b8071fc24a' -i -X PATCH \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/invitations/d589323e-143c-44fc-ad03-c4b8071fc24a"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

Invitation with HAL links.

{
  "id" : "d589323e-143c-44fc-ad03-c4b8071fc24a",
  "created" : "2024-04-10T14:08:22.068604",
  "lastModified" : "2024-04-10T14:08:22.668840522",
  "status" : "ACCEPTED",
  "email" : "[email protected]",
  "creator" : {
    "id" : "auth0|5eb0327cbfd7490bff55feeb",
    "name" : "[email protected]",
    "handle" : "@sit+prod"
  },
  "workspace" : {
    "id" : "67694fbd-f150-48ae-a3d4-ae68f5b2390f",
    "created" : "2024-04-10T14:08:06.893592",
    "lastModified" : "2024-04-10T14:08:06.893592",
    "alias" : "pyugnho",
    "name" : "Test Workspace [2024-04-10T14:08:06.890087406]",
    "repositoryUrl" : "DISABLED",
    "deploymentSecret" : "hukbqajhfbulvlbkrwwkokuydqlnfs",
    "appProperties" : { },
    "status" : "READY",
    "managed" : true
  }
}

Delete an invitation

DELETE

/api/invitations/{invitation-id}

Deletes a pending or revoked invitation {invitation-id}.

Prerequisites

  • The authenticated user must be the owner of workspace the invitation belongs to
  • or the authenticated user must have sent the invitation {invitation-id}

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/invitations/4a964b04-3ac2-4dfb-8d90-71fa1bd36abb' -i -X DELETE \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/invitations/4a964b04-3ac2-4dfb-8d90-71fa1bd36abb"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

204 No Content

No response body provided.

Withdraw an invitation

PUT

/api/invitations/{invitation-id}/revoked

Withdraws the pending or accepted invitation {invitation-id}.

Prerequisites

  • The authenticated user must be the owner of workspace the invitation belongs to
  • or the authenticated user must have sent the invitation {invitation-id}

Request

Example Snippets

cURL

curl -H "Authorization: Bearer $ACCESS_TOKEN" 'https://catalog.matatika.com:443/api/invitations/4a964b04-3ac2-4dfb-8d90-71fa1bd36abb/revoked' -i -X PUT \
    -H 'Accept: application/json, application/javascript, text/javascript, text/json' \
    -H 'Content-Type: application/json'

Python (requests)

import requests

url = "https://catalog.matatika.com:443/api/invitations/4a964b04-3ac2-4dfb-8d90-71fa1bd36abb/revoked"

headers = {
  'Authorization': ACCESS_TOKEN
}

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

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

Response

200 OK

No response body provided.