See api-docs Menu
  1. Home >
  2. API >
  3. v1-v3 >
  4. Groups >
  5. Get Group by ID

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 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

id

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

Postman Collection

Run In Postman

    Clicking Run in Postman button navigates to the page where you can fork the collection to your workspace. Forking the collection into your workspace will enable you to contribute to the source collection using pull requests. You can also view the collection in a public workspace if you like and even import a copy of the collection using the links present on the screen.

Have a Question?

Found a problem or a bug? Submit a support ticket.

Looking for walkthroughs or how-to guides on OneLogin's user and admin features? Check out the documentation in our Knowledge Base.

Have a product idea or request? Share it with us in our Ideas Portal.