Skip to content

Commit 4d818b1

Browse files
committed
Add API doc
1 parent 8e96d0e commit 4d818b1

File tree

3 files changed

+45
-0
lines changed

3 files changed

+45
-0
lines changed

docs/api/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,11 @@ To connect with other Sumo Logic users, post feedback, or ask a question, visit
210210
<a href="/docs/api/search-job"><img src={useBaseUrl('img/icons/search.png')} alt="Thumbnail icon" width="50"/><h4>Search Job</h4></a>
211211
</div>
212212
</div>
213+
<div className="box smallbox card">
214+
<div className="container">
215+
<a href="/docs/api/service-accounts"><img src={useBaseUrl('img/icons/business/user-permissions.png')} alt="Thumbnail icon" width="50"/><h4>Service Accounts</h4></a>
216+
</div>
217+
</div>
213218
<div className="box smallbox card">
214219
<div className="container">
215220
<a href="/docs/api/service-allowlist"><img src={useBaseUrl('img/icons/security/unlock.png')} alt="Thumbnail icon" width="50"/><h4>Service Allowlist</h4></a>

docs/api/service-accounts.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
id: service-accounts
3+
title: Service Accounts APIs
4+
sidebar_label: Service Accounts
5+
description: Use the API to manage service accounts.
6+
---
7+
8+
import useBaseUrl from '@docusaurus/useBaseUrl';
9+
import ApiIntro from '../reuse/api-intro.md';
10+
import ApiRoles from '../reuse/api-roles.md';
11+
12+
<img src={useBaseUrl('img/icons/business/user-permissions.png')} alt="icon" width="50"/>
13+
14+
The Service Accounts API allows you to manage service accounts. [Service accounts](/docs/manage/security/service-accounts/) are a special type of account designed for automating processes that use Sumo Logic APIs, such as scripts, integrations, and infrastructure as code. Unlike user accounts, service accounts are not associated with an individual and do not allow for interactive logins.
15+
16+
## Documentation
17+
18+
<ApiIntro/>
19+
20+
| Deployment | Documentation URL |
21+
|:------------|:--------------------------------------------------------------------|
22+
| AU | https://api.au.sumologic.com/docs/#tag//serviceAccountManagement |
23+
| CA | https://api.ca.sumologic.com/docs/#tag//serviceAccountManagement |
24+
| DE | https://api.de.sumologic.com/docs/#tag//serviceAccountManagement |
25+
| EU | https://api.eu.sumologic.com/docs/#tag//serviceAccountManagement |
26+
| FED | https://api.fed.sumologic.com/docs/#tag//serviceAccountManagement |
27+
| IN | https://api.in.sumologic.com/docs/#tag//serviceAccountManagement |
28+
| JP | https://api.jp.sumologic.com/docs/#tag//serviceAccountManagement |
29+
| KR | https://api.kr.sumologic.com/docs/#tag//serviceAccountManagement |
30+
| US1 | https://api.sumologic.com/docs/#tag//serviceAccountManagement |
31+
| US2 | https://api.us2.sumologic.com/docs/#tag//serviceAccountManagement |
32+
33+
## Required role capabilities
34+
35+
<ApiRoles/>
36+
37+
* User Management (all role capabilities)
38+
39+
Only administrators can create service accounts. If you are unsure whether you are an administrator, you can view your role in **Preferences** (see [Onboarding Checklists](https://help.sumologic.com/docs/get-started/onboarding-checklists/)).

sidebars.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3095,6 +3095,7 @@ integrations: [
30953095
'api/scan-budget',
30963096
'api/scheduled-views',
30973097
'api/search-job',
3098+
'api/service-accounts',
30983099
'api/service-allowlist',
30993100
'api/service-map',
31003101
'api/slo-management',

0 commit comments

Comments
 (0)