Dartmouth API Developer Portal

OIM Groups API

Returns groups that are provisioned to Active Directory from Grouper.

Rating

Attribute Value
Highly Available Yes
Cache Refresh Interval 15 minutes
Filtering Yes

Required Scopes

None: OIM Groups API requires only authentication to Dartmouth's login API

Request

GET /api/identity/oim_groups
GET /api/people/{netid}/oim_groups

Required Headers

Authorization: Bearer {jwt}

Parameters

Searching is allowed on netid and group_name in the query parameters. For example, to query all oim groups for a netid:

GET /api/identity/oim_groups?netid=f003r9n

To query a specific group

GET /api/identity/oim_groups?group_name=ITC Users

Sample Request

https://api.dartmouth.edu/api/identity/oim_groups
https://api.dartmouth.edu/api/identity/oim_groups?netid=f003r9n
https://api.dartmouth.edu/api/people/f003r9n/oim_groups
https://api.dartmouth.edu/api/people/f003r9n/oim_groups?group_name=ITC Users

Sample Return

[
    {
        "netid": "f003r9n",
        "group_name": "IRA_IDENTITY_MANAGEMENT_USERS",
        "email": "Nidhi.Singh@dartmouth.edu",
        "id": "f003r9n|IRA_IDENTITY_MANAGEMENT_USERS",
        "cache_date": "2024-05-28T15:37:12Z"
    }
]

[
    {
        "netid": "f003r9n",
        "group_name": "duoadmintest",
        "email": "Nidhi.Singh@dartmouth.edu",
        "id": "f003r9n|duoadmintest",
        "cache_date": "2024-05-28T18:07:33Z"
    },
    {
        "netid": "f003r9n",
        "group_name": "Business Transformation Team",
        "email": "Nidhi.Singh@dartmouth.edu",
        "id": "f003r9n|Business Transformation Team",
        "cache_date": "2024-05-28T15:37:12Z"
    },
    {
        "netid": "f003r9n",
        "group_name": "IRA_BASIC_ACCESS",
        "email": "Nidhi.Singh@dartmouth.edu",
        "id": "f003r9n|IRA_BASIC_ACCESS",
        "cache_date": "2024-05-28T15:37:12Z"
    }
]
Field Type Description
netid string netid of the group member
group_name string group name as specified in Grouper
email string email address of the group member
id string id is "netid" | "group_name"
cache_date string the last update of the cache for this record in iso8601 format