Jump to

• Request
• Response

Get a list of users mapped to groups in LearnCenter

get

/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}/users

Request

Path Parameters

• groupId: number
  Unique identifier of a Group.
• learnCenterId: number
  Unique identifier of LearnCenter.

Query Parameters

• limit(optional): integer
  Specifies how many items should be returned in a payload. Must be lower than server default limit size.
• offset(optional): integer
  Specify the starting point of the response.

  Default Value: 0
• totalResults(optional): boolean
  If set to true, the payload includes the total number of rows that satisfies the request. The use of this parameter determines if the 'last' link is displayed for a pageable collection.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Group users collection fetched.

Body ()

Root Schema : GroupUsersResponse

Type: object

Group users response object.

Show Source

• count(optional): number
  Count is the current number of records displayed in the response.
• hasMore(optional): boolean
  True indicates that we have more records to be displayed.
• items(optional): object GroupUserResponse
  Response object for group user mappings.
• limit(optional): number
  Limit implies the maximum number of records which can be displayed in the page.
• links(optional): array links

{
    "description":"Group users response object.",
    "type":"object",
    "properties":{
        "items":{
            "$ref":"#/definitions/GroupUserResponse"
        },
        "limit":{
            "type":"number",
            "description":"Limit implies the maximum number of records which can be displayed in the page."
        },
        "count":{
            "type":"number",
            "description":"Count is the current number of records displayed in the response."
        },
        "hasMore":{
            "type":"boolean",
            "description":"True indicates that we have more records to be displayed."
        },
        "links":{
            "type":"array",
            "items":{
                "properties":{
                    "rel":{
                        "type":"string"
                    },
                    "href":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "example":{
        "items":[
            {
                "groupId":1232,
                "group":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232"
                        }
                    ]
                },
                "userId":1120778,
                "user":{
                    "links":[
                        {
                            "rel":"canonical",
                            "href":"https://{url}/learn.rest/v1/users/1120778"
                        }
                    ]
                },
                "statusFlag":true,
                "excludeFlag":false,
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232/users/1120778"
                    }
                ]
            },
            {
                "...":null
            }
        ],
        "limit":100,
        "count":1,
        "hasMore":false,
        "links":[
            {
                "rel":"canonical",
                "href":"..learnCenters/178942/groups/1232/users"
            }
        ]
    }
}

Example:

{
    "items":[
        {
            "groupId":1232,
            "group":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232"
                    }
                ]
            },
            "userId":1120778,
            "user":{
                "links":[
                    {
                        "rel":"canonical",
                        "href":"https://{url}/learn.rest/v1/users/1120778"
                    }
                ]
            },
            "statusFlag":true,
            "excludeFlag":false,
            "links":[
                {
                    "rel":"canonical",
                    "href":"https://{url}/learn.rest/v1/learnCenters/178942/groups/1232/users/1120778"
                }
            ]
        },
        {
            "...":null
        }
    ],
    "limit":100,
    "count":1,
    "hasMore":false,
    "links":[
        {
            "rel":"canonical",
            "href":"..learnCenters/178942/groups/1232/users"
        }
    ]
}

Nested Schema : GroupUserResponse

Type: object

Response object for group user mappings.

Show Source

• excludeFlag(optional): boolean
  You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group.
• group(optional): object group
  Details of the group being mapped.
• groupId(optional): number
  Id of the group.
• links(optional): array links
  Link to the Group Users.
• statusFlag(optional): boolean
  Status of the Group. Enum for statusFlag are: active, inactive.
• user(optional): object user
  The user object used for group user mappings.
• userId(optional): number
  Id of the user in the group.

{
    "description":"Response object for group user mappings.",
    "type":"object",
    "properties":{
        "groupId":{
            "description":"Id of the group.",
            "type":"number"
        },
        "group":{
            "description":"Details of the group being mapped.",
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/GroupLinkItem"
                    }
                }
            }
        },
        "userId":{
            "description":"Id of the user in the group.",
            "type":"number"
        },
        "user":{
            "description":"The user object used for group user mappings.",
            "type":"object",
            "properties":{
                "links":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/UserLinkItem"
                    }
                }
            }
        },
        "statusFlag":{
            "type":"boolean",
            "description":"Status of the Group. Enum for statusFlag are: active, inactive."
        },
        "excludeFlag":{
            "type":"boolean",
            "description":" You can manually exclude Users from Dynamic Groups so that they are never automatically included even if they match the conditions for becoming members of the Dynamic Group."
        },
        "links":{
            "description":"Link to the Group Users.",
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupUserLinkItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "properties":{
            "rel":{
                "type":"string"
            },
            "href":{
                "type":"string"
            }
        }
    }
}

Nested Schema : group

Type: object

Details of the group being mapped.

Show Source

• links(optional): array links

{
    "description":"Details of the group being mapped.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/GroupLinkItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Link to the Group Users.

Show Source

• Array of: object GroupUserLinkItem
  Object comprising links to the users in the group.

{
    "description":"Link to the Group Users.",
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupUserLinkItem"
    }
}

Nested Schema : user

Type: object

The user object used for group user mappings.

Show Source

• links(optional): array links

{
    "description":"The user object used for group user mappings.",
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserLinkItem"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object GroupLinkItem
  Link to a group item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/GroupLinkItem"
    }
}

Nested Schema : GroupLinkItem

Type: object

Link to a group item.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}
• rel(optional): string
  Example: canonical

{
    "description":"Link to a group item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenters/{learnCenterId}/groups/{groupId}"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learnCenters/178409/groups/456"
}

Nested Schema : GroupUserLinkItem

Type: object

Object comprising links to the users in the group.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}
• rel(optional): string
  Example: canonical

{
    "description":"Object comprising links to the users in the group.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/learnCenter/{learnCenterId}/groups/{groupId}/users/{userId}"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/users/112867"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/learnCenter/178409/groups/456/users/112867"
}

Nested Schema : links

Type: array

Show Source

• Array of: object UserLinkItem
  Object of the User Link Item.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserLinkItem"
    }
}

Nested Schema : UserLinkItem

Type: object

Object of the User Link Item.

Show Source

• href(optional): string
  Example: {url}/learn.rest/v1/users/456
• rel(optional): string
  Example: canonical

{
    "description":"Object of the User Link Item.",
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "example":"canonical"
        },
        "href":{
            "type":"string",
            "example":"{url}/learn.rest/v1/users/456"
        }
    },
    "example":{
        "rel":"canonical",
        "href":"{url}/learn.rest/v1/users/456"
    }
}

Example:

{
    "rel":"canonical",
    "href":"{url}/learn.rest/v1/users/456"
}

Nested Schema : items

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Authentication refused for provided credentials or token invalid.

Headers

• WWW_Authenticate: string

500 Response

Internal server error.

Back to Top