IdentityAccessMembersOf
The membersOf service returns the members of a specified group.
Base URL: /domains/legacy/identity/access/membersof
Version: v1
Summary
Path | Operation | Description |
---|---|---|
/documentation | GET | service definition |
/{group_id} | GET | Returns the person_ids of the individual members of a specified group |
Paths
GET /documentation
service definition
Uses default content-types: application/json
- 200 OK
-
Success
GET /{group_id}
Tags: MembersOfServiceReturns the person_ids of the individual members of a specified group
group_id | string -> | path | string | |
filter_attributes | string -> query by filter attributes | query | string |
Uses default content-types: application/json
- 200 OK
-
Service request is OK and a response has been generated.
Example for application/json{
"MembersOf Service": {
"request": {
"attributes": "",
"method": "GET",
"resource": "/GROUPID",
"status": "200"
},
"resource": {
"URI": "/identity/cgi/membersOf.cgi/group_id[/personid|netid]",
"attributes": "Attributes are allowed to further refine the membership set definition. Attributes only apply to some groups. For example the group that returns the set of students who have registered for a class can be further refined by providing a year_term, curriculum_id, title_code and section_number.",
"examples": [
"/Registered",
"/Registered/123456789"
],
"identifiers": {
"group_id": {
"description": "Identifier of a named group or set of individuals",
"required": true
},
"personid": {
"description": "Unique identifier of an individual",
"required": false
}
},
"methods": {
"options": [
"GET"
]
}
},
"response": {
"members": [
"111111111",
"222222222",
"333333333",
"444444444",
"555555555"
],
"rows": 5,
"warnings": [
]
}
}
} - 400 Bad Request
-
There appears to be a syntax error in the composition of the service request. The response structure may contain information about the error. If the base URI or service request URI is invalid, any response will come as an HTTP response.
- 401 Unauthorized
-
Failure to authenticate
- 403 Forbidden
-
The user does not have access to the resource.
- 404 Not Found
-
The target resource can not be found for the provided resource identifiers.
- 500 Internal Server Error
-
An error occurred generating the response to the service request. This is strictly a server error and not an application error.
Schema definitions
- WebService: object
-
- name: string
-
- operations: operations
-
- errors: errors
-
- httpStatusCodes: httpStatusCodes
-
- name: string
-
- description: string
-
- method: string
-
- path: string
-
- path_identifiers: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- query_attributes: object[]
-
object - name: string
-
- type: string
-
- format: string
-
- required: string
-
- methods: object
-
- options: string[]
-
string
- URI: string
-
- examples: string[]
-
string - identifiers: object
-
- group_id: object
-
- description: string
-
- required: boolean
-
- personid: object
-
- description: string
-
- required: boolean
-
- attributes: string
-