Groups.getExpiredUsers (Method)
Returns zero or more structures, each containing information about expired users, the groups they were in, and other related information.
Returns:
Groups_GetExpiredUsers_Result (query)
Each row of the returned query results has the following fields:
Field Name | Type | Description |
---|---|---|
FullName | PlainText_NonNull | The expired user's first and last name. |
GroupID | GroupID | The group's ID. |
GroupName | PlainText_NonNull_255 | The group's name. |
UserID | UserID | The expired user's ID. |
UserName | PlainText_NonNull_50 | The expired user's username (for example, ssmith). |
Arguments:
Name | Type | Required | Description |
---|---|---|---|
groupID | GroupID_Deletable_NEG1 | Optional. Defaults to '-1'. | A group's ID. If this is not -1, CommonSpot returns information for this group. If it is -1, CommonSpot returns information on all expired users for all groups. The group ID can not be one of the standard default groups (0-Anonymous, 1-Authenticated, 2-Contributor). |
Context:
License Requirements | None |
Permission Requirements | Contributor |
Deny Context | None |
Require Context | None |
Author Lock | (not required) |
Transaction Logging | Transaction logging is disabled for this method |
Customization | Customization is not supported for this method. |
Error Codes:
None
Notes:
None