Skip to content

Latest commit

 

History

History
680 lines (465 loc) · 12.5 KB

USER-GROUPS.md

File metadata and controls

680 lines (465 loc) · 12.5 KB
Raw

User Groups

Manage user groups.

Table of Contents

List User Groups

GET /api/session/data/{{data_source}}/userGroups

Headers

None.

Path Parameters

  • data_source (string, required) - Data source

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO

Details of User Group

GET /api/session/data/{{data_source}}/userGroups/{{user_group}}

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

None.

Response

Status Code

  • 200 - OK

Response Body

@TODO

Add Members to User Group

Add members to an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUsers

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/",
    "value": "{{username}}"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Add Member Groups to User Group

Add member groups to an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/memberUserGroups

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/",
    "value": "{{userGroupIdentifier}}"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Add Parent Groups to User Group

Add parent groups to an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/userGroups

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/",
    "value": "{{userGroupIdentifier}}"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Assign Permissions to User Group

Assign permissions to an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/connectionPermissions/{{user_group}}",
    "value": "READ"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_USER"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "ADMINISTER"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_USER_GROUP"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_SHARING_PROFILE"
  },
  {
    "op": "add",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION_GROUP"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Revoke Permissions from User Group

Revoke permissions from an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/connectionPermissions/{{user_group}}",
    "value": "READ"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_USER"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "ADMINISTER"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_USER_GROUP"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_SHARING_PROFILE"
  },
  {
    "op": "remove",
    "path": "/systemPermissions",
    "value": "CREATE_CONNECTION_GROUP"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Assign Connections to User Group

Assign connections to an user group

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "add",
    "path": "/connectionPermissions/{{connection}}",
    "value": "READ"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Revoke Connections from User Group

Revoke connections from an user group.

PATCH /api/session/data/{{data_source}}/userGroups/{{user_group}}/permissions

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

Body must be json-patch format.

[
  {
    "op": "remove",
    "path": "/connectionPermissions/{{connection}}",
    "value": "READ"
  }
]

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Update User Group

Updates user group.

PUT /api/session/data/{{data_source}}/userGroups/{{user_group}}

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth Token

Request Body

@TODO

{
  "identifier": "test",
  "attributes": {
    "disabled": ""
  }
}

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Create User Group

Create a user group.

POST /api/session/data/{{data_source}}/userGroups

Headers

  • Content-Type (string, required) - application/json

Path Parameters

  • data_source (string, required) - Data source

Query Parameters

  • token (string, required) - Auth Token

Request Body

@TODO

{
  "identifier": "test",
  "attributes": {
    "disabled": ""
  }
}

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Delete User Group

Delete user group.

DELETE /api/session/data/{{data_source}}/userGroups/{{user_group}}

Headers

None.

Path Parameters

  • data_source (string, required) - Data source
  • user_group (string, required) - User group identifier

Query Parameters

  • token (string, required) - Auth token

Request Body

None.

Response

Status Code

  • 204 - No Content

Response Body

This request does not return a response body.

Back to Top