Groups

Manage groups.

List groups

get

Lists all available groups.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Query parameters

namestringOptional

The name of the group.

Example: Sales

mappingstringOptional

The group mapping which can contain provider or identity.

Example: Sales

createdOnstring · dateOptional

The created date of the group.

Example: 2021-12-31

lastModifiedOnstring · dateOptional

The last modified date of the group.

Example: 2021-12-31

sortFieldstringOptional

Sort field options available for groups. Possible values are: NAME, CREATED_ON or LAST_MODIFIED_ON.

sortOrderstringOptional

Order on the sort field options available for groups. Possible values are: ASC or DESC.

limitinteger · min: 1 · max: 500Optional

This is the maximum number of results that may be returned. Fewer may be returned than the value of limit.

Do not depend on the number of results being fewer than the limit value to indicate that your query reached the end of the list of data, use the absence of after (see Cursors) instead. For example, if you set limit to 10 and 9 results are returned, there may be more data available.

If not set, the default limit (limit = 25) will be used. The maximum value for this parameter is 500.

Default: 25

afterstring · nullableOptional

This is the cursor that points to the end of the page of data that has been returned.

Responses

200

The list of groups.

application/json

A page of groups.

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

500

An unexpected error has occurred.

application/json

get/groups

HTTPcURLJavaScriptPython

GET /rest/protect/v1/groups HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "cursors": {
    "after": "Y3Vyc29yV2hlblRoZXJlSXNNb3JlRGF0YQo"
  },
  "results": [
    {
      "name": "text",
      "mappings": [
        {
          "provider": "Snowflake",
          "identity": "text"
        }
      ]
    }
  ]
}

Add a new group

post

Adds a new group.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Body

application/json

namestringRequired

The name of the group.

Responses

201

The group has been added.

application/json

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

post/groups

HTTPcURLJavaScriptPython

POST /rest/protect/v1/groups HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "name": "Sales",
  "mappings": [
    {
      "provider": "Snowflake",
      "identity": "SALES"
    }
  ]
}

Add a group for Snowflake onlyAdd a group for Google BigQuery onlyAdd a group for AWS Lake Formation onlyAdd a group with multiple mappings

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "name": "text",
  "mappings": [
    {
      "provider": "Snowflake",
      "identity": "text"
    }
  ]
}

Retrieve a group

get

Returns information about the group with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the group.

Responses

200

The group with the specified ID.

application/json

namestringRequired

The name of the group.

idstring · uuidRequired

The ID of the group.

createdBystring · uuidRequired

Id of the Collibra user who created this group

createdOninteger · int64Required

Timestamp when this group is created

lastModifiedBystring · uuidRequired

Id of the Collibra user who last updated this group

lastModifiedOninteger · int64Required

Timestamp when this group has last been updated

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

get/groups/{id}

HTTPcURLJavaScriptPython

GET /rest/protect/v1/groups/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "name": "text",
  "mappings": [
    {
      "provider": "Snowflake",
      "identity": "text"
    }
  ]
}

Delete a group

delete

Deletes the group with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the group.

Responses

204

The group has been deleted.

No content

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

500

An unexpected error has occurred.

application/json

delete/groups/{id}

HTTPcURLJavaScriptPython

DELETE /rest/protect/v1/groups/{id} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Update a group

patch

Updates the group with the specified ID.

Authorizations

basicAuthjwtAuth

AuthorizationstringRequired

Collibra REST API authentication using Basic Authentication.

Path parameters

idstring · uuidRequired

The universally unique identifier (UUID) of the group.

Body

application/json

namestringOptional

The name of the group.

Responses

200

Group has been updated.

application/json

namestringRequired

The name of the group.

idstring · uuidRequired

The ID of the group.

createdBystring · uuidRequired

Id of the Collibra user who created this group

createdOninteger · int64Required

Timestamp when this group is created

lastModifiedBystring · uuidRequired

Id of the Collibra user who last updated this group

lastModifiedOninteger · int64Required

Timestamp when this group has last been updated

400

The request is not valid.

application/json

401

The client is not authenticated.

application/json

403

The user lacks permissions.

application/json

404

Resource not found.

application/json

409

Conflicts found.

application/json

500

An unexpected error has occurred.

application/json

patch/groups/{id}

HTTPcURLJavaScriptPython

PATCH /rest/protect/v1/groups/{id} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "name": "text",
  "mappings": [
    {
      "provider": "Snowflake",
      "identity": "text"
    }
  ]
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "123e4567-e89b-12d3-a456-426614174000",
  "createdOn": 1,
  "lastModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "lastModifiedOn": 1,
  "name": "text",
  "mappings": [
    {
      "provider": "Snowflake",
      "identity": "text"
    }
  ]
}