getUsersFromGroup
Get users from group
Details
- Method:
GET - Path:
/rest/api/3/group/member - Operation ID:
getUsersFromGroup
Parameters
{
"groupname": {
"description": "As a group's name can change, use of `groupId` is recommended to identify a group. \nThe name of the group. This parameter cannot be used with the `groupId` parameter.",
"required": false,
"location": "query",
"type": "string"
},
"groupId": {
"description": "The ID of the group. This parameter cannot be used with the `groupName` parameter.",
"required": false,
"location": "query",
"type": "string"
},
"includeInactiveUsers": {
"description": "Include inactive users.",
"required": false,
"location": "query",
"type": "boolean"
},
"startAt": {
"description": "The index of the first item to return in a page of results (page offset).",
"required": false,
"location": "query",
"type": "integer",
"format": "int64"
},
"maxResults": {
"description": "The maximum number of items to return per page (number should be between 1 and 50).",
"required": false,
"location": "query",
"type": "integer",
"format": "int32"
}
}Response Schema
{
"additionalProperties": false,
"description": "A page of items.",
"properties": {
"isLast": {
"description": "Whether this is the last page.",
"readOnly": true,
"type": "boolean"
},
"maxResults": {
"description": "The maximum number of items that could be returned.",
"format": "int32",
"readOnly": true,
"type": "integer"
},
"nextPage": {
"description": "If there is another page of results, the URL of the next page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the page.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"startAt": {
"description": "The index of the first item returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"total": {
"description": "The number of items returned.",
"format": "int64",
"readOnly": true,
"type": "integer"
},
"values": {
"description": "The list of items.",
"items": {
"additionalProperties": false,
"description": "User details permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:\n\n * User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, `displayName` provides an indication and other parameters have default values or are blank (for example, email is blank).\n * User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, `accountId` returns *unknown* and all other parameters have fallback values.\n * User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.",
"properties": {
"accountId": {
"description": "The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, *5b10ac8d82e05b22cc7d4ef5*.",
"maxLength": 128,
"type": "string"
},
"accountType": {
"description": "The type of account represented by this user. This will be one of 'atlassian' (normal users), 'app' (application user) or 'customer' (Jira Service Desk customer user)",
"readOnly": true,
"type": "string"
},
"active": {
"description": "Whether the user is active.",
"readOnly": true,
"type": "boolean"
},
"avatarUrls": {
"allOf": [
{
"$ref": "#/components/schemas/AvatarUrlsBean"
}
],
"description": "The avatars of the user.",
"readOnly": true
},
"displayName": {
"description": "The display name of the user. Depending on the user’s privacy settings, this may return an alternative value.",
"readOnly": true,
"type": "string"
},
"emailAddress": {
"description": "The email address of the user. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
},
"key": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"name": {
"description": "This property is no longer available and will be removed from the documentation soon. See the [deprecation notice](https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/) for details.",
"readOnly": true,
"type": "string"
},
"self": {
"description": "The URL of the user.",
"readOnly": true,
"type": "string"
},
"timeZone": {
"description": "The time zone specified in the user's profile. Depending on the user’s privacy settings, this may be returned as null.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"readOnly": true,
"type": "array"
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getUsersFromGroup', {
# Add required parameters here
})