Admin SDK API
Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.
Productivity & workspace#openapi#analytics#media
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain.
Endpoints 6
activities
- GETRetrieves a list of activities for a specific customer's account and application such as the Admin console application…
/admin/reports/v1/activity/users/:userKey/applications/:applicationName?actorIpAddress=string&agentInfoFilter=string&applicationInfoFilter=string&customerId=string&deviceFilter=string&endTime=string&eventName=string&filters=string&groupIdFilter=string&includeSensitiveData=true&maxResults=0&networkInfoFilter=string&orgUnitID=string&pageToken=string&resourceDetailsFilter=string&startTime=string&statusFilter=stringRetrieves a list of activities for a specific customer's account and application such as the Admin console application or the Google Drive application. For… - POSTStart receiving notifications for account activities
/admin/reports/v1/activity/users/:userKey/applications/:applicationName/watch?actorIpAddress=string&customerId=string&endTime=string&eventName=string&filters=string&groupIdFilter=string&maxResults=0&orgUnitID=string&pageToken=string&startTime=stringStart receiving notifications for account activities. For more information, see Receiving Push Notifications.
channels
- POSTStop watching resources through this channel.
/admin/reports_v1/channels/stopStop watching resources through this channel.
customerUsageReports
- GETRetrieves a report which is a collection of properties and statistics for a specific customer's account
/admin/reports/v1/usage/dates/:date?customerId=string&pageToken=string¶meters=stringRetrieves a report which is a collection of properties and statistics for a specific customer's account. For more information, see the Customers Usage Report…
entityUsageReports
- GETRetrieves a report which is a collection of properties and statistics for entities used by users within the account
/admin/reports/v1/usage/:entityType/:entityKey/dates/:date?customerId=string&filters=string&maxResults=0&pageToken=string¶meters=stringRetrieves a report which is a collection of properties and statistics for entities used by users within the account. For more information, see the Entities…
userUsageReport
- GETRetrieves a report which is a collection of properties and statistics for a set of users with the account
/admin/reports/v1/usage/users/:userKey/dates/:date?customerId=string&filters=string&groupIdFilter=string&maxResults=0&orgUnitID=string&pageToken=string¶meters=stringRetrieves a report which is a collection of properties and statistics for a set of users with the account. For more information, see the User Usage Report…
API details
- Base URL
https://admin.googleapis.com- Authentication
- OAuth 2.0 (authorization code flow) with 2 scopes
An API key in the key query parameter - Operations
- 6 operations on 6 pathsGET 4POST 2
- Main resources
- activities 2channels 1customerUsageReports 1entityUsageReports 1userUsageReport 1
- Response formats
application/json- Description format
- Google API Discovery, API version
reports_v1 - Links
- Documentation · OpenAPI document
- Listed from
- Google API Discovery document (googleapis/discovery-artifact-manager) (Apache-2.0)
How to test the Admin SDK API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Admin SDK API collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (authorization code flow) with 2 scopes. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Retrieves a list of activities for a specific customer's account and application such as the Admin console application…” (GET /admin/reports/v1/activity/users/:userKey/applications/:applicationName?actorIpAddress=string&agentInfoFilter=string&applicationInfoFilter=string&customerId=string&deviceFilter=string&endTime=string&eventName=string&filters=string&groupIdFilter=string&includeSensitiveData=true&maxResults=0&networkInfoFilter=string&orgUnitID=string&pageToken=string&resourceDetailsFilter=string&startTime=string&statusFilter=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Admin SDK API?
Admin SDK lets administrators of enterprise domains to view and manage resources like user, groups etc. It also provides audit and usage reports of domain. It is listed under Productivity & workspace and has 6 endpoints.
Who publishes the Admin SDK API?
It is listed from Google's public API description (an OpenAPI document), not published by Google on Swastik Codes. Anyone who controls googleapis.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Admin SDK API?
Requests go to https://admin.googleapis.com. Endpoint paths are added to this base URL.
How do I authenticate with the Admin SDK API?
It accepts 2 methods: OAuth 2.0 (authorization code flow) with 2 scopes; an API key in the key query parameter.
How many endpoints does the Admin SDK API have?
6 operations on 6 paths (4 GET, 2 POST). The largest groups are activities, channels, customerUsageReports, entityUsageReports.
Is forking the Admin SDK API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.