-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #4 from strick-j/3-add-remote-access-secure-web-se…
…ssions-auth-helper 3 add remote access secure web sessions auth helper
- Loading branch information
Showing
93 changed files
with
9,793 additions
and
26 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,5 @@ | ||
# dependencies | ||
node_modules | ||
package-lock.json | ||
SaaS/Cloud Onboarding | ||
|
||
# testing | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
114 changes: 114 additions & 0 deletions
114
SaaS/Remote Access/v1-edge/Activities/Retrieve Activities.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
meta { | ||
name: Retrieve Activities | ||
type: http | ||
seq: 1 | ||
} | ||
|
||
get { | ||
url: https://{{remoteAccessBaseUrl}}/v1-edge/activities?activityTypes=ApplicationDeleted, ApplicationUpdated, ApplicationEnabled, ApplicationDisabled | ||
body: none | ||
auth: none | ||
} | ||
|
||
query { | ||
activityTypes: ApplicationDeleted, ApplicationUpdated, ApplicationEnabled, ApplicationDisabled | ||
~fromTime: 0 | ||
~toTime: 0 | ||
~offset: 0 | ||
~limit: 100 | ||
} | ||
|
||
assert { | ||
res.body: isJson | ||
res.status: eq 200 | ||
} | ||
|
||
script:pre-request { | ||
const remoteAccessAuth = require('./tools/remoteAccessAuth'); | ||
|
||
// Perform authentication usings remoteAccessAuth.js tools | ||
await remoteAccessAuth.login(); | ||
} | ||
|
||
docs { | ||
## Get Remote Access Tenant's Activities - v1 | ||
Get list of Activities, happened between specified period | ||
|
||
### URL | ||
https://api.alero.io/v1-edge/activities | ||
|
||
#### Resource Information | ||
| HTTP Method | GET | | ||
| :-- | :-- | | ||
|
||
#### URL Query Parameters | ||
| Parameter | Type | Mandatory | Description | | ||
| :-- | :-- | :-- | :-- | | ||
| activityTypes | array of strings | yes | List of Activity Types to retrieve. **Available values:** ApplicationCreated, ApplicationDeleted, ApplicationUpdated, ApplicationEnabled, ApplicationDisabled, ApplicationUserLogin, ConnectorCreated, ConnectorDeleted, ConnectorInitializationExtended, ConnectorInitialized, ConnectorUpdated, ConnectorLdapUpdated, ConnectorLdapInitialized, ConnectorLdapStopped, GroupsCreated, GroupsDeleted, GroupsUpdated, SettingsUpdated, SiteCreated, SiteDeleted, SiteUpdated, TenantAliasUpdated, TenantCreated, TenantLogin, UserActivated, UserDeactivated, VendorActivated, VendorDeactivated, VendorUpdated, UserDeleteFromTenant, VendorDeleteFromTenant, UserJoinTenant, VendorJoinTenant, UserCreated, UserUpdated, UserRoleChanged, ApplicationVendorLogin, AppCertificateCreated, AppCertificateDeleted, AppCertificateUpdated, CompanyUserInvitationCreate, VendorInvitationCreate, ServiceAccountCreated, ServiceAccountDeleted, ServiceAccountActivated, ServiceAccountDeactivated, ApplicationLoginBlocked, DirectAccessUserResponse, DirectAccessConnectionDenied, OfflineAccessUserViewedPassword, IdaptiveVendorSync, IdaptiveRoleSync, CompanyInviterUpdated| | ||
| fromTime | integer | no | From epoch Time **Example:** 1669923609709. **Default:** 0 | | ||
| toTime | integer | no | To epoch Time **Example:** 1669923609709. **Default:** 0 | | ||
| offset | integer | no | Starting activity offset. Default: 0 | | ||
| limit | integer | no | Limit number or returned Activities. Default: 100 | | ||
|
||
### Request | ||
#### Request Header | ||
| Request Header | Field Definition | | ||
| :-- | :-- | | ||
| Authorization | Bearer eyEXAMPLErQ | | ||
|
||
#### Request Body | ||
None | ||
|
||
### Response | ||
|
||
#### Status Codes | ||
| Code | Description | | ||
| :-- | :-- | | ||
| 200 | OK | | ||
| 400 | Custom Error | | ||
| 401 | Unauthorized | | ||
| 404 | Not Found | | ||
| 500 | Internal Server Error | | ||
|
||
#### 200 OK | ||
``` | ||
{ | ||
"activities": [ | ||
{ | ||
"activityType": "ApplicationCreated", | ||
"activityData": { | ||
"id": "string", | ||
"time": 0, | ||
"initiatedById": "string", | ||
"initiatedByName": "string", | ||
"initiatedByRole": "string", | ||
"certId": "string", | ||
"siteId": "string", | ||
"siteName": "string", | ||
"displayName": "string", | ||
"description": "string", | ||
"creationTime": 0, | ||
"updateTime": 0, | ||
"createdByUserId": "string", | ||
"updatedByUserId": "string", | ||
"subjectName": "string", | ||
"validFrom": 0, | ||
"validTo": 0 | ||
} | ||
} | ||
], | ||
"totalCount": 0 | ||
} | ||
``` | ||
|
||
#### 400 Bad Request | ||
``` | ||
{ | ||
"type": "about:blank", | ||
"title": "Bad Request", | ||
"status": 400, | ||
"detail": "Required parameter 'activityTypes' is not present.", | ||
"instance": "/v2-edge/activities" | ||
} | ||
``` | ||
} |
114 changes: 114 additions & 0 deletions
114
SaaS/Remote Access/v1-edge/Applications/Retrieve Applications by Site.bru
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,114 @@ | ||
meta { | ||
name: Retrieve Applications by Site | ||
type: http | ||
seq: 1 | ||
} | ||
|
||
get { | ||
url: https://{{remoteAccessBaseUrl}}/v1-edge/sites/{{siteId}}/applications | ||
body: none | ||
auth: none | ||
} | ||
|
||
query { | ||
~offset: 0 | ||
~limit: 100 | ||
} | ||
|
||
vars:pre-request { | ||
siteId: | ||
} | ||
|
||
assert { | ||
res.body: isJson | ||
res.status: eq 200 | ||
} | ||
|
||
script:pre-request { | ||
const remoteAccessAuth = require('./tools/remoteAccessAuth'); | ||
const tools = require('./tools/tools'); | ||
|
||
// Perform authentication usings remoteAccessAuth.js tools | ||
await remoteAccessAuth.login(); | ||
|
||
// Sets Remote Access Site ID for testing based on environment flag and variables | ||
var flag = bru.getEnvVar('testFlag') | ||
if (flag == 'true') { | ||
tools.log('Setting Variables'); | ||
bru.setVar('siteId', bru.getEnvVar('testRemoteAccessSiteId')); | ||
tools.log('Remote Access Site Id Set: ' + bru.getVar('siteId')) | ||
} | ||
} | ||
|
||
docs { | ||
## Get Remote Access Tenant's Sites - v1 | ||
Retrieves a list of tenant sites | ||
|
||
### URL | ||
https://api.alero.io/v1-edge/sites/{siteId}/applications | ||
|
||
#### Resource Information | ||
| HTTP Method | GET | | ||
| :-- | :-- | | ||
|
||
#### URL Path Parameters | ||
| Parameter | Type | Mandatory | Description | | ||
| :-- | :-- | :-- | :-- | | ||
| siteId | string | yes | Unique Site ID to retreive applications for | | ||
|
||
#### URL Query Parameters | ||
| Parameter | Type | Mandatory | Description | | ||
| :-- | :-- | :-- | :-- | | ||
| offset | integer | no | Starting activity offset. Default: 0 | | ||
| limit | integer | no | Limit number or returned Activities. Default: 100 | | ||
|
||
### Request | ||
#### Request Header | ||
| Request Header | Field Definition | | ||
| :-- | :-- | | ||
| Authorization | Bearer eyEXAMPLErQ | | ||
|
||
#### Request Body | ||
None | ||
|
||
### Response | ||
|
||
#### Status Codes | ||
| Code | Description | | ||
| :-- | :-- | | ||
| 200 | OK | | ||
| 400 | Custom Error | | ||
| 401 | Unauthorized | | ||
| 404 | Not Found | | ||
| 500 | Internal Server Error | | ||
|
||
#### 200 OK | ||
``` | ||
{ | ||
"applications": [ | ||
{ | ||
"id": "string", | ||
"name": "string", | ||
"authenticationMethod": "SAML", | ||
"createdByUserId": "string", | ||
"creationTime": 0, | ||
"lastUpdatedByUserId": "string", | ||
"lastUpdateTime": 0, | ||
"logo": "string", | ||
"internalUri": "string", | ||
"certificateId": "string", | ||
"externalUri": "string", | ||
"nestedApplications": [ | ||
{ | ||
"externalUri": "string", | ||
"internalUri": "string", | ||
"certificateId": "string" | ||
} | ||
], | ||
"enabled": true | ||
} | ||
], | ||
"totalCount": 0 | ||
} | ||
``` | ||
} |
Oops, something went wrong.