Groups

Get All Groups

This endpoint returns a list of Group resources.

GET /api/v2/groups/

GET /api/v2/groups/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": "G64",
        "name": "Group 64",
        "updated": "2016-07-29T21:02:33.764620Z",
        "description": "Group description",
        "role": "UR4"
    }]
}

Expand Parameters

See the Expand Parameters section for more details.

Parameter Description
role Role field is expanded to include to id and name fields. 
GET /api/v2/groups/?expand=role
Accept: application/json
Authorization: Token: "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": "G64",
        "name": "Group 64",
        "updated": "2016-07-29T21:02:19.780768Z",
        "description": "Group description",
        "role": {
            "id": "UR1",
            "name": "User"
        }
    }]
}

Include Parameters

See the Include Parameters section for more details.

Parameter Description
groups Includes a list of nested groups that are directly a member of the parent group
users Includes a list of direct users a part of the group.
all_users Include a list of direct and indirect users of the group.
total_user_count Includes the total number of users (direct and indirect) in the group.
sync_connections Includes a list of Sync Connections that include the group in their mappings 
GET /api/v2/groups/?include=groups,users,all_users,total_user_count
Accept: application/json
Authorization: Token: "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "results": [{
        "id": "G64",
        "name": "Group 64",
        "updated": "2016-07-29T21:02:19.780768Z",
        "description": "Group description",
        "role": "UR4",
        "users": [{
            "first_name": "Frank",
            "last_name": "Testerton",
            "is_active": true,
            "id": 2,
            "email": "frank@example.com",
            "role": {
                    "id": "UR1",
                    "name": "User"
            }
        }],
        "groups": [{
            "role": "User",
            "id": "G1",
            "name": "Example Group"
        }],
        "total_user_count": 2,
        "all_users": [
            {
                "first_name": "Frank",
                "last_name": "Testerton",
                "is_active": true,
                "id": 2,
                "email": "frank@example.com",
                "role": {
                    "id": "UR1",
                    "name": "User"
                }
            },
            {
                "first_name": "Linda",
                "last_name": "Graham",
                "is_active": false,
                "id": 3,
                "email": "linda@example.com",
                "role": {
                    "id": "UR1",
                    "name": "User"
                }
            }
        ],
        "sync_connections": ["LDAP Connection"]
    }]
}

Get a Specific Group

This endpoint retreives a specific Group Resource as specified by the group_id.

GET /api/v2/groups/{group_id}/

URL Parameters

Parameter Description
group_id The id of the Group to retrieve 
GET /api/v2/groups/G64/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "G64",
    "name": "Group 64",
    "updated": "2016-07-29T21:02:19.780768Z",
    "description": "Group description",
    "role": "UR4"
}

Create a Group

Create a Group resource.

POST /api/v2/groups/

Fields Required Description
name Yes The name of the group resource
description No The description of the group
role Yes The role of the group
users No A list of dictionaries representing the users who are part of the business unit. Each dictionary has an email field.
groups No A list of group ids representing the nested groups who are part of the parent group. 
POST /api/v2/groups/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "Group 2",
    "role": "UR5",
    "users": [{"email": "frank@example.com"}],
    "groups": ["G1"]
}

HTTP/1.1 201 CREATED
Content-Type: application/json

{
    "id": "G2",
    "name": "Group 2",
    "updated": "2016-07-29T21:02:19.780768Z",
    "description": "",
    "role": "UR5",
    "users": [{
        "first_name": "Frank",
        "last_name": "Testerton",
        "is_active": true,
        "id": 2,
        "email": "frank@example.com",
        "role": {
            "id": "UR1",
            "name": "User"
        }
    }],
    "groups": [{
        "role": "User",
        "id": "G1",
        "name": "Example Group"
    }]
}

Update a specific Group

Update a specific Group resource.

PATCH /api/v2/groups/{group_id}/

URL Parameters

Parameter Description
group_id The ID of the Group to update
role The ID of the global role 
PATCH /api/v2/groups/G2/ HTTP/1.1
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

{
    "name": "User Experience Group",
    "description": "Deals with designing user experiences",
    "role": "UR1"
}

HTTP/1.1 200 OK
Content-Type: application/json

{
    "id": "G2",
    "name": "User Experience Group",
    "updated": "2016-07-29T21:02:19.780768Z",
    "description": "Deals with designing user experiences",
    "role": "UR1",
    "users": [{
        "first_name": "Frank",
        "last_name": "Testerton",
        "is_active": true,
        "id": 2,
        "email": "frank@example.com",
        "role": {
            "id": "UR1",
            "name": "User"
        }
    }],
    "groups": [{
        "role": "User",
        "id": "G1",
        "name": "Example Group"
    }]
}

Delete a Group

This endpoint deletes a single Group resource, as specified by the id parameter.

DELETE /groups/{group_id}/

Parameter Description
group_id The id of the group to delete 
DELETE api/v2/groups/G1/
Accept: application/json
Authorization: Token "YOUR SDE ACCESS TOKEN"

HTTP/1.1 204 NO CONTENT

results matching ""

    No results matching ""