Skip to content

Commit b6f873b

Browse files
Renabled Swagger for Intel
Task/intel 63388 intel apis
2 parents b753e47 + bba51dc commit b6f873b

8 files changed

Lines changed: 7 additions & 427 deletions

File tree

docs/Authentication.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -108,9 +108,7 @@ Successful responses include an access token and related fields. Below is an ill
108108
}
109109
```
110110

111-
The access_token in the response can be used to call Omnissa Intelligence APIs.
112-
113-
On the **[REST APIs](REST-APIs.md)** page, the token panel above Swagger UI can use these service account credentials to fetch an access token and automatically populate Swagger's Bearer authorization for the Intelligence APIs. If the browser cannot call the auth endpoint because of CORS or network restrictions, obtain the token outside Swagger UI and paste the returned `access_token` into Swagger's Bearer auth input manually.
111+
The access_token in the response can be used to call Omnissa Intelligence APIs. When exploring endpoints on **[REST APIs](REST-APIs.md)**, paste the returned `access_token` into Swagger's **Authorize** button.
114112

115113
---
116114

docs/REST-APIs.md

Lines changed: 0 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,4 @@ The Omnissa Intelligence (formerly Workspace ONE Intelligence) V2 API documentat
1111

1212
Substitute your tenant’s regional **`api`** host name for examples that use hosts such as `api.sandbox.data.workspaceone.com`.
1313

14-
<section id="swagger-token-bridge" class="swagger-token-bridge" aria-labelledby="swagger-token-bridge-title">
15-
<h2 id="swagger-token-bridge-title">Get Access Token For Swagger</h2>
16-
<p>Enter the service account credentials from your downloaded JSON file to fetch an access token and automatically populate Swagger's Bearer authorization for the Intelligence APIs.</p>
17-
<form id="swagger-token-bridge-form" class="swagger-token-bridge__form">
18-
<label class="swagger-token-bridge__field">
19-
<span>Auth host</span>
20-
<input id="swagger-auth-host" name="authHost" type="url" placeholder="https://auth.sandbox.data.workspaceone.com" autocomplete="url" required />
21-
</label>
22-
<label class="swagger-token-bridge__field">
23-
<span>clientId</span>
24-
<input id="swagger-client-id" name="clientId" type="text" placeholder="your-client-id@{tenant}.data.workspaceone.com" autocomplete="username" required />
25-
</label>
26-
<label class="swagger-token-bridge__field">
27-
<span>clientSecret</span>
28-
<input id="swagger-client-secret" name="clientSecret" type="password" autocomplete="current-password" required />
29-
</label>
30-
<div class="swagger-token-bridge__actions">
31-
<button id="swagger-token-submit" type="submit">Get access token</button>
32-
<p class="swagger-token-bridge__hint">If you already have a JWT, you can still use Swagger's <strong>Authorize</strong> button to paste it directly into Bearer auth.</p>
33-
</div>
34-
</form>
35-
<p id="swagger-token-bridge-status" class="swagger-token-bridge__status" role="status" aria-live="polite"></p>
36-
</section>
37-
3814
<swagger-ui src="intelligence-rest-api-swagger.json" />

docs/assets/javascripts/swagger-token-bridge.js

Lines changed: 0 additions & 143 deletions
This file was deleted.

docs/assets/stylesheets/extra.css

Lines changed: 0 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1 @@
11
/* Theme extras (stub for local builds when repo assets are incomplete). */
2-
3-
.swagger-token-bridge {
4-
margin: 1.5rem 0;
5-
padding: 1rem;
6-
border: 1px solid rgba(127, 127, 127, 0.25);
7-
border-radius: 0.5rem;
8-
background: rgba(127, 127, 127, 0.06);
9-
}
10-
11-
.swagger-token-bridge > :first-child {
12-
margin-top: 0;
13-
}
14-
15-
.swagger-token-bridge__form {
16-
display: grid;
17-
gap: 0.75rem;
18-
}
19-
20-
.swagger-token-bridge__field {
21-
display: grid;
22-
gap: 0.35rem;
23-
}
24-
25-
.swagger-token-bridge__field input {
26-
width: 100%;
27-
padding: 0.65rem 0.75rem;
28-
border: 1px solid rgba(127, 127, 127, 0.35);
29-
border-radius: 0.35rem;
30-
background: var(--md-default-bg-color, #fff);
31-
color: inherit;
32-
}
33-
34-
.swagger-token-bridge__actions {
35-
display: grid;
36-
gap: 0.5rem;
37-
}
38-
39-
.swagger-token-bridge__actions button {
40-
justify-self: start;
41-
padding: 0.65rem 1rem;
42-
border: 0;
43-
border-radius: 0.35rem;
44-
background: var(--md-primary-fg-color, #005eb8);
45-
color: var(--md-primary-bg-color, #fff);
46-
cursor: pointer;
47-
}
48-
49-
.swagger-token-bridge__actions button:disabled {
50-
opacity: 0.7;
51-
cursor: progress;
52-
}
53-
54-
.swagger-token-bridge__hint,
55-
.swagger-token-bridge__status {
56-
margin: 0;
57-
}
58-
59-
.swagger-token-bridge__status[data-state="success"] {
60-
color: #0f7b0f;
61-
}
62-
63-
.swagger-token-bridge__status[data-state="error"] {
64-
color: #b42318;
65-
}

docs/index.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ hide:
55
- toc
66
---
77

8-
{% if enable_swagger_openapi %}
9-
108
![Omnissa Intelligence](assets/logos/favicon-dark.svg){ align=right }
119

1210
The Omnissa Intelligence (formerly Workspace ONE Intelligence) V2 API documentation describes how to query and extract data for use in other business intelligence tools. It also helps with building General Data Protection Regulation (GDPR) compliant tools and applications with REST APIs.
@@ -103,7 +101,7 @@ API calls to Omnissa Intelligence are always authenticated using a JSON Web Toke
103101

104102
If access tokens are expired or invalid, the API invoked returns an HTTP status **401 (Unauthorized)**.
105103

106-
Step-by-step credential setup is on **[Authentication](Authentication.md)**.
104+
Refer to **[Authentication](Authentication.md)** for step-by-step credential setup.
107105

108106
### API error handling
109107

@@ -157,17 +155,3 @@ Refer to **Table 1. API Call Limits Per Organization** in the PDF for Standard,
157155
1. Follow **[Authentication](Authentication.md)** to configure a service account and retrieve tokens.
158156
2. Explore endpoints in **[REST APIs](REST-APIs.md)**.
159157
3. Compare payloads using **[Sample responses](API-sample-responses.md)**.
160-
161-
{% else %}
162-
163-
![Omnissa Intelligence](assets/logos/favicon-dark.svg){ align=right }
164-
165-
The Omnissa Intelligence API documentation describes how to query and extract data for use in other business intelligence tools. It also helps with building General Data Protection Regulation (GDPR) compliant tools and applications with REST APIs.
166-
167-
## Documentation and Reference
168-
169-
| Name | Link |
170-
| --- | --- |
171-
| API Documentation for Omnissa Intelligence V2 | [Download PDF](https://developer.omnissa.com/omnissa-intelligence-apis/guides/DHUB-APIDocumentationforOmnissaIntelligence-V2-130326-183145.pdf){ .md-button } |
172-
173-
{% endif %}

0 commit comments

Comments
 (0)