getGroup
Get group
Details
- Method:
GET - Path:
/rest/api/3/group - Operation ID:
getGroup
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"
},
"expand": {
"description": "List of fields to expand.",
"required": false,
"location": "query",
"type": "string"
}
}Response Schema
{
"additionalProperties": false,
"properties": {
"expand": {
"description": "Expand options that include additional group details in the response.",
"readOnly": true,
"type": "string",
"xml": {
"attribute": true
}
},
"groupId": {
"description": "The ID of the group, which uniquely identifies the group across all Atlassian products. For example, *952d12c3-5b5b-4d04-bb32-44d383afc4b2*.",
"nullable": true,
"type": "string"
},
"name": {
"description": "The name of group.",
"type": "string"
},
"self": {
"description": "The URL for these group details.",
"format": "uri",
"readOnly": true,
"type": "string"
},
"users": {
"allOf": [
{
"$ref": "#/components/schemas/PagedListUserDetailsApplicationUser"
}
],
"description": "A paginated list of the users that are members of the group. A maximum of 50 users is returned in the list, to access additional users append `[start-index:end-index]` to the expand request. For example, to access the next 50 users, use`?expand=users[51:100]`.",
"readOnly": true
}
},
"type": "object"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('jira')
# Call this tool
result = await agent.call_tool('getGroup', {
# Add required parameters here
})