⚠️ v1-v3 APIs have been deprecated.
Although these APIs are not shut off yet, all new development with APIs should use the newest version of our API if available, and the version /1 in all other cases. These later versions are based on RESTful principles, secured by OAuth 2.0, and provide JSON messages, search, pagination, sorting, and filtering.

GET

Get Group by ID

Think of groups as departments. Groups enable you to split your user base into smaller pieces that can be more easily managed. For more info, see Groups.

Resource URL

Before calling this API, consider using its version /1 equivalent.

https://api.onelogin.com/api/v1/groups/:id

Parameters

required

string

Set to the group's ID with .xml appended. For example, 123456.xml. If you don't know the group's id, use the Get all groups API call to return all groups and their id values.

Sample Response

200 OK
404 Not Found

<group>
  <id>412878</id>
  <name>Engineering</name>
  <reference nil="true"></reference>
</group>

<error>
  <title>No such group</title>
  <message>No Group found by Reference or ID '2878'</message>
</error>

Response Elements

`id`	Group's unique ID in OneLogin.
`name`	Group name.
`reference`	Deprecated. Will always show the attribute `nil="true"`.

Sample cURL Request

Be sure to replace placeholder values surrounded by { } with actual values.

curl -u {api_key}:x -X GET https://api.onelogin.com/api/v1/groups/{group_id}.xml