losant_rest 1.11.1 → 1.14.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/README.md +1 -1
- data/docs/_schemas.md +34959 -19022
- data/docs/application.md +46 -5
- data/docs/applicationApiTokens.md +1 -1
- data/docs/applicationDashboard.md +133 -0
- data/docs/applicationDashboards.md +93 -0
- data/docs/applicationKeys.md +3 -2
- data/docs/applications.md +1 -1
- data/docs/dataTable.md +1 -1
- data/docs/dataTableRows.md +1 -1
- data/docs/dataTables.md +1 -1
- data/docs/device.md +43 -0
- data/docs/devices.md +41 -2
- data/docs/edgeDeployment.md +49 -0
- data/docs/events.md +3 -3
- data/docs/experience.md +1 -1
- data/docs/experienceDomains.md +1 -1
- data/docs/experienceEndpoint.md +1 -0
- data/docs/experienceGroup.md +2 -0
- data/docs/experienceSlugs.md +1 -1
- data/docs/experienceVersion.md +3 -3
- data/docs/experienceVersions.md +2 -2
- data/docs/experienceView.md +4 -4
- data/docs/experienceViews.md +2 -2
- data/docs/file.md +5 -5
- data/docs/files.md +2 -2
- data/docs/flow.md +41 -0
- data/docs/flowVersions.md +44 -0
- data/docs/flows.md +1 -0
- data/docs/instance.md +166 -0
- data/docs/instanceApiToken.md +133 -0
- data/docs/instanceApiTokens.md +91 -0
- data/docs/instanceMember.md +133 -0
- data/docs/instanceMembers.md +91 -0
- data/docs/instanceOrg.md +135 -0
- data/docs/instanceOrgInvite.md +139 -0
- data/docs/instanceOrgInvites.md +96 -0
- data/docs/instanceOrgMember.md +139 -0
- data/docs/instanceOrgMembers.md +96 -0
- data/docs/instanceOrgs.md +91 -0
- data/docs/instances.md +50 -0
- data/docs/integration.md +1 -0
- data/docs/me.md +1 -1
- data/docs/org.md +1 -1
- data/docs/userApiToken.md +125 -0
- data/docs/userApiTokens.md +87 -0
- data/docs/webhook.md +1 -0
- data/lib/losant_rest.rb +18 -1
- data/lib/losant_rest/application.rb +53 -6
- data/lib/losant_rest/application_api_token.rb +1 -1
- data/lib/losant_rest/application_api_tokens.rb +2 -2
- data/lib/losant_rest/application_certificate.rb +1 -1
- data/lib/losant_rest/application_certificate_authorities.rb +1 -1
- data/lib/losant_rest/application_certificate_authority.rb +1 -1
- data/lib/losant_rest/application_certificates.rb +1 -1
- data/lib/losant_rest/application_dashboard.rb +176 -0
- data/lib/losant_rest/application_dashboards.rb +138 -0
- data/lib/losant_rest/application_key.rb +1 -1
- data/lib/losant_rest/application_keys.rb +4 -1
- data/lib/losant_rest/application_template.rb +1 -1
- data/lib/losant_rest/application_templates.rb +1 -1
- data/lib/losant_rest/applications.rb +2 -2
- data/lib/losant_rest/audit_log.rb +1 -1
- data/lib/losant_rest/audit_logs.rb +1 -1
- data/lib/losant_rest/auth.rb +1 -1
- data/lib/losant_rest/client.rb +71 -3
- data/lib/losant_rest/dashboard.rb +1 -1
- data/lib/losant_rest/dashboards.rb +1 -1
- data/lib/losant_rest/data.rb +1 -1
- data/lib/losant_rest/data_table.rb +2 -2
- data/lib/losant_rest/data_table_row.rb +1 -1
- data/lib/losant_rest/data_table_rows.rb +2 -2
- data/lib/losant_rest/data_tables.rb +2 -2
- data/lib/losant_rest/device.rb +51 -1
- data/lib/losant_rest/device_recipe.rb +1 -1
- data/lib/losant_rest/device_recipes.rb +1 -1
- data/lib/losant_rest/devices.rb +49 -3
- data/lib/losant_rest/edge_deployment.rb +81 -0
- data/lib/losant_rest/edge_deployments.rb +1 -1
- data/lib/losant_rest/error.rb +1 -1
- data/lib/losant_rest/event.rb +1 -1
- data/lib/losant_rest/events.rb +4 -4
- data/lib/losant_rest/experience.rb +2 -2
- data/lib/losant_rest/experience_domain.rb +1 -1
- data/lib/losant_rest/experience_domains.rb +2 -2
- data/lib/losant_rest/experience_endpoint.rb +3 -1
- data/lib/losant_rest/experience_endpoints.rb +1 -1
- data/lib/losant_rest/experience_group.rb +5 -1
- data/lib/losant_rest/experience_groups.rb +1 -1
- data/lib/losant_rest/experience_slug.rb +1 -1
- data/lib/losant_rest/experience_slugs.rb +2 -2
- data/lib/losant_rest/experience_user.rb +1 -1
- data/lib/losant_rest/experience_users.rb +1 -1
- data/lib/losant_rest/experience_version.rb +4 -4
- data/lib/losant_rest/experience_versions.rb +3 -3
- data/lib/losant_rest/experience_view.rb +5 -5
- data/lib/losant_rest/experience_views.rb +3 -3
- data/lib/losant_rest/file.rb +5 -5
- data/lib/losant_rest/files.rb +3 -3
- data/lib/losant_rest/flow.rb +47 -1
- data/lib/losant_rest/flow_version.rb +1 -1
- data/lib/losant_rest/flow_versions.rb +51 -1
- data/lib/losant_rest/flows.rb +3 -1
- data/lib/losant_rest/instance.rb +226 -0
- data/lib/losant_rest/instance_api_token.rb +176 -0
- data/lib/losant_rest/instance_api_tokens.rb +136 -0
- data/lib/losant_rest/instance_member.rb +176 -0
- data/lib/losant_rest/instance_members.rb +134 -0
- data/lib/losant_rest/instance_org.rb +180 -0
- data/lib/losant_rest/instance_org_invite.rb +182 -0
- data/lib/losant_rest/instance_org_invites.rb +138 -0
- data/lib/losant_rest/instance_org_member.rb +182 -0
- data/lib/losant_rest/instance_org_members.rb +138 -0
- data/lib/losant_rest/instance_orgs.rb +139 -0
- data/lib/losant_rest/instances.rb +88 -0
- data/lib/losant_rest/integration.rb +3 -1
- data/lib/losant_rest/integrations.rb +1 -1
- data/lib/losant_rest/me.rb +2 -2
- data/lib/losant_rest/notebook.rb +1 -1
- data/lib/losant_rest/notebooks.rb +1 -1
- data/lib/losant_rest/org.rb +2 -2
- data/lib/losant_rest/org_invites.rb +1 -1
- data/lib/losant_rest/orgs.rb +1 -1
- data/lib/losant_rest/user_api_token.rb +170 -0
- data/lib/losant_rest/user_api_tokens.rb +132 -0
- data/lib/losant_rest/utils.rb +1 -1
- data/lib/losant_rest/version.rb +2 -2
- data/lib/losant_rest/webhook.rb +3 -1
- data/lib/losant_rest/webhooks.rb +1 -1
- data/schemas/advancedApplicationKeyQuery.json +1082 -0
- data/schemas/advancedDeviceQuery.json +309 -0
- data/schemas/advancedFlowQuery.json +218 -0
- data/schemas/advancedFlowVersionQuery.json +218 -0
- data/schemas/apiToken.json +2 -1
- data/schemas/apiTokenPost.json +431 -0
- data/schemas/apiTokens.json +4 -2
- data/schemas/applicationApiTokenPost.json +8 -0
- data/schemas/applicationDashboardPost.json +5687 -0
- data/schemas/applicationGlobalPatch.json +33 -0
- data/schemas/auditLog.json +4 -0
- data/schemas/auditLogFilter.json +4 -0
- data/schemas/auditLogs.json +4 -0
- data/schemas/bulkDeleteResponse.json +12 -0
- data/schemas/dashboard.json +66 -17
- data/schemas/dashboardPatch.json +66 -17
- data/schemas/dashboardPost.json +66 -17
- data/schemas/dashboardSendReport.json +4 -0
- data/schemas/dashboards.json +66 -17
- data/schemas/devicePayloadCounts.json +24 -0
- data/schemas/devicesDeletePost.json +309 -0
- data/schemas/devicesExportPayloadCountPost.json +1350 -0
- data/schemas/devicesExportPost.json +309 -0
- data/schemas/devicesPatch.json +309 -0
- data/schemas/devicesRemoveDataPost.json +309 -0
- data/schemas/edgeDeployment.json +16 -0
- data/schemas/edgeDeployments.json +16 -0
- data/schemas/experienceGroup.json +6 -0
- data/schemas/experienceGroups.json +6 -0
- data/schemas/experienceLinkedResources.json +45 -0
- data/schemas/filePost.json +8 -2
- data/schemas/files.json +3 -0
- data/schemas/flow.json +15 -0
- data/schemas/flowPatch.json +15 -0
- data/schemas/flowPost.json +15 -0
- data/schemas/flowStorageMetadata.json +13 -0
- data/schemas/flowVersion.json +30 -0
- data/schemas/flowVersionPost.json +15 -0
- data/schemas/flowVersions.json +30 -0
- data/schemas/flowVersionsDeletePost.json +941 -0
- data/schemas/flows.json +15 -0
- data/schemas/flowsImportPost.json +30 -0
- data/schemas/flowsImportResult.json +45 -0
- data/schemas/githubLogin.json +72 -1
- data/schemas/historicalSummaries.json +43 -0
- data/schemas/historicalSummary.json +490 -0
- data/schemas/instance.json +192 -0
- data/schemas/instanceMember.json +41 -0
- data/schemas/instanceMemberPatch.json +17 -0
- data/schemas/instanceMemberPost.json +37 -0
- data/schemas/instanceMembers.json +77 -0
- data/schemas/instanceOrg.json +133 -0
- data/schemas/instanceOrgMember.json +45 -0
- data/schemas/instanceOrgMemberPatch.json +69 -0
- data/schemas/instanceOrgMemberPost.json +161 -0
- data/schemas/instanceOrgMembers.json +42 -0
- data/schemas/instanceOrgPatch.json +122 -0
- data/schemas/instanceOrgPost.json +291 -0
- data/schemas/instanceOrgs.json +178 -0
- data/schemas/instancePatch.json +67 -0
- data/schemas/instanceReportOptionsPost.json +41 -0
- data/schemas/instances.json +43 -0
- data/schemas/me.json +30 -14
- data/schemas/multiDeviceCommand.json +309 -0
- data/schemas/notebook.json +45 -0
- data/schemas/notebookPatch.json +30 -0
- data/schemas/notebookPost.json +30 -0
- data/schemas/notebooks.json +45 -0
- data/schemas/org.json +30 -14
- data/schemas/orgInvite.json +90 -0
- data/schemas/orgInviteCollection.json +130 -0
- data/schemas/orgInvites.json +82 -77
- data/schemas/orgPatch.json +0 -9
- data/schemas/orgRoleInfo.json +69 -0
- data/schemas/orgs.json +30 -14
- data/schemas/payloadStats.json +126 -0
- data/schemas/userCredentials.json +72 -1
- data/schemas/userPost.json +72 -1
- data/schemas/validateContextError.json +34 -0
- data/schemas/validateContextSuccess.json +34 -0
- data/schemas/virtualButtonPress.json +4 -0
- metadata +68 -3
@@ -0,0 +1,139 @@
|
|
1
|
+
# Instance Org Member Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Org Member resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Delete](#delete)
|
10
|
+
* [Get](#get)
|
11
|
+
* [Patch](#patch)
|
12
|
+
|
13
|
+
<br/>
|
14
|
+
|
15
|
+
## Delete
|
16
|
+
|
17
|
+
Deletes an organization member
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.instance_org_member.delete(
|
21
|
+
instanceId: my_instance_id,
|
22
|
+
orgId: my_org_id,
|
23
|
+
userId: my_user_id)
|
24
|
+
|
25
|
+
puts result
|
26
|
+
```
|
27
|
+
|
28
|
+
#### Authentication
|
29
|
+
The client must be configured with a valid api access token to call this
|
30
|
+
action. The token must include at least one of the following scopes:
|
31
|
+
all.Instance, all.User, instanceOrgMember.*, or instanceOrgMember.delete.
|
32
|
+
|
33
|
+
#### Available Parameters
|
34
|
+
|
35
|
+
| Name | Type | Required | Description | Default | Example |
|
36
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
37
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
38
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
39
|
+
| userId | string | Y | ID associated with the organization member | | 575ec8687ae143cd83dc4a94 |
|
40
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
41
|
+
|
42
|
+
#### Successful Responses
|
43
|
+
|
44
|
+
| Code | Type | Description |
|
45
|
+
| ---- | ---- | ----------- |
|
46
|
+
| 200 | [Success](_schemas.md#success) | If member was successfully deleted |
|
47
|
+
|
48
|
+
#### Error Responses
|
49
|
+
|
50
|
+
| Code | Type | Description |
|
51
|
+
| ---- | ---- | ----------- |
|
52
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
53
|
+
| 404 | [Error](_schemas.md#error) | Error if organization or member was not found |
|
54
|
+
|
55
|
+
<br/>
|
56
|
+
|
57
|
+
## Get
|
58
|
+
|
59
|
+
Returns an organization member
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
result = client.instance_org_member.get(
|
63
|
+
instanceId: my_instance_id,
|
64
|
+
orgId: my_org_id,
|
65
|
+
userId: my_user_id)
|
66
|
+
|
67
|
+
puts result
|
68
|
+
```
|
69
|
+
|
70
|
+
#### Authentication
|
71
|
+
The client must be configured with a valid api access token to call this
|
72
|
+
action. The token must include at least one of the following scopes:
|
73
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMember.*, or instanceOrgMember.get.
|
74
|
+
|
75
|
+
#### Available Parameters
|
76
|
+
|
77
|
+
| Name | Type | Required | Description | Default | Example |
|
78
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
79
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
80
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
81
|
+
| userId | string | Y | ID associated with the organization member | | 575ec8687ae143cd83dc4a94 |
|
82
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
83
|
+
|
84
|
+
#### Successful Responses
|
85
|
+
|
86
|
+
| Code | Type | Description |
|
87
|
+
| ---- | ---- | ----------- |
|
88
|
+
| 200 | [Instance Org Member](_schemas.md#instance-org-member) | A single organization member |
|
89
|
+
|
90
|
+
#### Error Responses
|
91
|
+
|
92
|
+
| Code | Type | Description |
|
93
|
+
| ---- | ---- | ----------- |
|
94
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
95
|
+
| 404 | [Error](_schemas.md#error) | Error if instance, organization, or member was not found |
|
96
|
+
|
97
|
+
<br/>
|
98
|
+
|
99
|
+
## Patch
|
100
|
+
|
101
|
+
Modifies the role of an organization member
|
102
|
+
|
103
|
+
```ruby
|
104
|
+
result = client.instance_org_member.patch(
|
105
|
+
instanceId: my_instance_id,
|
106
|
+
orgId: my_org_id,
|
107
|
+
userId: my_user_id,
|
108
|
+
member: my_member)
|
109
|
+
|
110
|
+
puts result
|
111
|
+
```
|
112
|
+
|
113
|
+
#### Authentication
|
114
|
+
The client must be configured with a valid api access token to call this
|
115
|
+
action. The token must include at least one of the following scopes:
|
116
|
+
all.Instance, all.User, instanceOrgMember.*, or instanceOrgMember.patch.
|
117
|
+
|
118
|
+
#### Available Parameters
|
119
|
+
|
120
|
+
| Name | Type | Required | Description | Default | Example |
|
121
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
122
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a95 |
|
123
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
124
|
+
| userId | string | Y | ID associated with the organization member | | 575ec8687ae143cd83dc4a94 |
|
125
|
+
| member | [Instance Org Member Patch](_schemas.md#instance-org-member-patch) | Y | Object containing new member info | | [Instance Org Member Patch Example](_schemas.md#instance-org-member-patch-example) |
|
126
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
127
|
+
|
128
|
+
#### Successful Responses
|
129
|
+
|
130
|
+
| Code | Type | Description |
|
131
|
+
| ---- | ---- | ----------- |
|
132
|
+
| 200 | [Instance Org Member](_schemas.md#instance-org-member) | The modified organization member |
|
133
|
+
|
134
|
+
#### Error Responses
|
135
|
+
|
136
|
+
| Code | Type | Description |
|
137
|
+
| ---- | ---- | ----------- |
|
138
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
139
|
+
| 404 | [Error](_schemas.md#error) | Error if organization or member was not found |
|
@@ -0,0 +1,96 @@
|
|
1
|
+
# Instance Org Members Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Org Members resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Get](#get)
|
10
|
+
* [Post](#post)
|
11
|
+
|
12
|
+
<br/>
|
13
|
+
|
14
|
+
## Get
|
15
|
+
|
16
|
+
Returns a collection of instance organization members
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.instance_org_members.get(
|
20
|
+
instanceId: my_instance_id,
|
21
|
+
orgId: my_org_id)
|
22
|
+
|
23
|
+
puts result
|
24
|
+
```
|
25
|
+
|
26
|
+
#### Authentication
|
27
|
+
The client must be configured with a valid api access token to call this
|
28
|
+
action. The token must include at least one of the following scopes:
|
29
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgMembers.*, or instanceOrgMembers.get.
|
30
|
+
|
31
|
+
#### Available Parameters
|
32
|
+
|
33
|
+
| Name | Type | Required | Description | Default | Example |
|
34
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
35
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
36
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
37
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: email, role | email | role |
|
38
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
39
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: email, role | | email |
|
40
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * instance |
|
41
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
42
|
+
|
43
|
+
#### Successful Responses
|
44
|
+
|
45
|
+
| Code | Type | Description |
|
46
|
+
| ---- | ---- | ----------- |
|
47
|
+
| 200 | [Instance Organization Members](_schemas.md#instance-organization-members) | A collection of instance organization members |
|
48
|
+
|
49
|
+
#### Error Responses
|
50
|
+
|
51
|
+
| Code | Type | Description |
|
52
|
+
| ---- | ---- | ----------- |
|
53
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
54
|
+
| 404 | [Error](_schemas.md#error) | Error if instance was not found |
|
55
|
+
|
56
|
+
<br/>
|
57
|
+
|
58
|
+
## Post
|
59
|
+
|
60
|
+
Creates a new organization member
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
result = client.instance_org_members.post(
|
64
|
+
instanceId: my_instance_id,
|
65
|
+
orgId: my_org_id,
|
66
|
+
member: my_member)
|
67
|
+
|
68
|
+
puts result
|
69
|
+
```
|
70
|
+
|
71
|
+
#### Authentication
|
72
|
+
The client must be configured with a valid api access token to call this
|
73
|
+
action. The token must include at least one of the following scopes:
|
74
|
+
all.Instance, all.User, instanceOrgMembers.*, or instanceOrgMembers.post.
|
75
|
+
|
76
|
+
#### Available Parameters
|
77
|
+
|
78
|
+
| Name | Type | Required | Description | Default | Example |
|
79
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
80
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
81
|
+
| orgId | string | Y | ID associated with the organization | | 575ec8687ae143cd83dc4a97 |
|
82
|
+
| member | [Instance Org Member Post](_schemas.md#instance-org-member-post) | Y | Object containing new member info | | [Instance Org Member Post Example](_schemas.md#instance-org-member-post-example) |
|
83
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
84
|
+
|
85
|
+
#### Successful Responses
|
86
|
+
|
87
|
+
| Code | Type | Description |
|
88
|
+
| ---- | ---- | ----------- |
|
89
|
+
| 200 | [Instance Org Member](_schemas.md#instance-org-member) | The newly created instance member |
|
90
|
+
|
91
|
+
#### Error Responses
|
92
|
+
|
93
|
+
| Code | Type | Description |
|
94
|
+
| ---- | ---- | ----------- |
|
95
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
96
|
+
| 404 | [Error](_schemas.md#error) | Error if instance was not found |
|
@@ -0,0 +1,91 @@
|
|
1
|
+
# Instance Orgs Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instance Orgs resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Get](#get)
|
10
|
+
* [Post](#post)
|
11
|
+
|
12
|
+
<br/>
|
13
|
+
|
14
|
+
## Get
|
15
|
+
|
16
|
+
Returns the organizations associated with the current instance
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
result = client.instance_orgs.get(instanceId: my_instance_id)
|
20
|
+
|
21
|
+
puts result
|
22
|
+
```
|
23
|
+
|
24
|
+
#### Authentication
|
25
|
+
The client must be configured with a valid api access token to call this
|
26
|
+
action. The token must include at least one of the following scopes:
|
27
|
+
all.Instance, all.Instance.read, all.User, all.User.read, instanceOrgs.*, or instanceOrgs.get.
|
28
|
+
|
29
|
+
#### Available Parameters
|
30
|
+
|
31
|
+
| Name | Type | Required | Description | Default | Example |
|
32
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
33
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
34
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
35
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
36
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
37
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
38
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
39
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my*org |
|
40
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
41
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
42
|
+
|
43
|
+
#### Successful Responses
|
44
|
+
|
45
|
+
| Code | Type | Description |
|
46
|
+
| ---- | ---- | ----------- |
|
47
|
+
| 200 | [Instance Organizations](_schemas.md#instance-organizations) | A collection of organizations |
|
48
|
+
|
49
|
+
#### Error Responses
|
50
|
+
|
51
|
+
| Code | Type | Description |
|
52
|
+
| ---- | ---- | ----------- |
|
53
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
54
|
+
|
55
|
+
<br/>
|
56
|
+
|
57
|
+
## Post
|
58
|
+
|
59
|
+
Create a new organization
|
60
|
+
|
61
|
+
```ruby
|
62
|
+
result = client.instance_orgs.post(instanceId: my_instance_id)
|
63
|
+
|
64
|
+
puts result
|
65
|
+
```
|
66
|
+
|
67
|
+
#### Authentication
|
68
|
+
The client must be configured with a valid api access token to call this
|
69
|
+
action. The token must include at least one of the following scopes:
|
70
|
+
all.Instance, all.User, instanceOrgs.*, or instanceOrgs.post.
|
71
|
+
|
72
|
+
#### Available Parameters
|
73
|
+
|
74
|
+
| Name | Type | Required | Description | Default | Example |
|
75
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
76
|
+
| instanceId | string | Y | ID associated with the instance | | 575ec8687ae143cd83dc4a97 |
|
77
|
+
| summaryInclude | string | N | Comma-separated list of summary fields to include in org summary | | payloadCount |
|
78
|
+
| orgConfig | [Instance Owned Organization Post](_schemas.md#instance-owned-organization-post) | N | Object containing configurations for the new organization | | [Instance Owned Organization Post Example](_schemas.md#instance-owned-organization-post-example) |
|
79
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
80
|
+
|
81
|
+
#### Successful Responses
|
82
|
+
|
83
|
+
| Code | Type | Description |
|
84
|
+
| ---- | ---- | ----------- |
|
85
|
+
| 200 | [Organization](_schemas.md#organization) | The newly created organization |
|
86
|
+
|
87
|
+
#### Error Responses
|
88
|
+
|
89
|
+
| Code | Type | Description |
|
90
|
+
| ---- | ---- | ----------- |
|
91
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/instances.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
# Instances Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
Instances resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Get](#get)
|
10
|
+
|
11
|
+
<br/>
|
12
|
+
|
13
|
+
## Get
|
14
|
+
|
15
|
+
Returns a collection of instances
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
result = client.instances.get(optional_params)
|
19
|
+
|
20
|
+
puts result
|
21
|
+
```
|
22
|
+
|
23
|
+
#### Authentication
|
24
|
+
The client must be configured with a valid api access token to call this
|
25
|
+
action. The token must include at least one of the following scopes:
|
26
|
+
all.User, all.User.read, instances.*, or instances.get.
|
27
|
+
|
28
|
+
#### Available Parameters
|
29
|
+
|
30
|
+
| Name | Type | Required | Description | Default | Example |
|
31
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
32
|
+
| sortField | string | N | Field to sort the results by. Accepted values are: name, id, creationDate, lastUpdated | name | name |
|
33
|
+
| sortDirection | string | N | Direction to sort the results by. Accepted values are: asc, desc | asc | asc |
|
34
|
+
| page | string | N | Which page of results to return | 0 | 0 |
|
35
|
+
| perPage | string | N | How many items to return per page | 100 | 10 |
|
36
|
+
| filterField | string | N | Field to filter the results by. Blank or not provided means no filtering. Accepted values are: name | | name |
|
37
|
+
| filter | string | N | Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. | | my * instance |
|
38
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
39
|
+
|
40
|
+
#### Successful Responses
|
41
|
+
|
42
|
+
| Code | Type | Description |
|
43
|
+
| ---- | ---- | ----------- |
|
44
|
+
| 200 | [Instances](_schemas.md#instances) | Collection of instances |
|
45
|
+
|
46
|
+
#### Error Responses
|
47
|
+
|
48
|
+
| Code | Type | Description |
|
49
|
+
| ---- | ---- | ----------- |
|
50
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
data/docs/integration.md
CHANGED
@@ -35,6 +35,7 @@ all.Application, all.Organization, all.User, integration.*, or integration.delet
|
|
35
35
|
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
36
36
|
| applicationId | string | Y | ID associated with the application | | 575ec8687ae143cd83dc4a97 |
|
37
37
|
| integrationId | string | Y | ID associated with the integration | | 575ed78e7ae143cd83dc4aab |
|
38
|
+
| includeWorkflows | string | N | If the workflows that utilize this integration should also be deleted. | | true |
|
38
39
|
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
39
40
|
|
40
41
|
#### Successful Responses
|
data/docs/me.md
CHANGED
@@ -376,7 +376,7 @@ all.User, all.User.read, me.*, or me.payloadCounts.
|
|
376
376
|
|
377
377
|
| Code | Type | Description |
|
378
378
|
| ---- | ---- | ----------- |
|
379
|
-
| 200 | [Payload
|
379
|
+
| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
|
380
380
|
|
381
381
|
#### Error Responses
|
382
382
|
|
data/docs/org.md
CHANGED
@@ -247,7 +247,7 @@ all.Organization, all.Organization.read, all.User, all.User.read, org.*, or org.
|
|
247
247
|
|
248
248
|
| Code | Type | Description |
|
249
249
|
| ---- | ---- | ----------- |
|
250
|
-
| 200 | [Payload
|
250
|
+
| 200 | [Payload Stats](_schemas.md#payload-stats) | Payload counts, by type and source |
|
251
251
|
|
252
252
|
#### Error Responses
|
253
253
|
|
@@ -0,0 +1,125 @@
|
|
1
|
+
# User Api Token Actions
|
2
|
+
|
3
|
+
Details on the various actions that can be performed on the
|
4
|
+
User Api Token resource, including the expected
|
5
|
+
parameters and the potential responses.
|
6
|
+
|
7
|
+
##### Contents
|
8
|
+
|
9
|
+
* [Delete](#delete)
|
10
|
+
* [Get](#get)
|
11
|
+
* [Patch](#patch)
|
12
|
+
|
13
|
+
<br/>
|
14
|
+
|
15
|
+
## Delete
|
16
|
+
|
17
|
+
Deletes an API Token
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
result = client.user_api_token.delete(apiTokenId: my_api_token_id)
|
21
|
+
|
22
|
+
puts result
|
23
|
+
```
|
24
|
+
|
25
|
+
#### Authentication
|
26
|
+
The client must be configured with a valid api access token to call this
|
27
|
+
action. The token must include at least one of the following scopes:
|
28
|
+
all.User, userApiToken.*, or userApiToken.delete.
|
29
|
+
|
30
|
+
#### Available Parameters
|
31
|
+
|
32
|
+
| Name | Type | Required | Description | Default | Example |
|
33
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
34
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
35
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
36
|
+
|
37
|
+
#### Successful Responses
|
38
|
+
|
39
|
+
| Code | Type | Description |
|
40
|
+
| ---- | ---- | ----------- |
|
41
|
+
| 200 | [Success](_schemas.md#success) | If API token was successfully deleted |
|
42
|
+
|
43
|
+
#### Error Responses
|
44
|
+
|
45
|
+
| Code | Type | Description |
|
46
|
+
| ---- | ---- | ----------- |
|
47
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
48
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|
49
|
+
|
50
|
+
<br/>
|
51
|
+
|
52
|
+
## Get
|
53
|
+
|
54
|
+
Retrieves information on an API token
|
55
|
+
|
56
|
+
```ruby
|
57
|
+
result = client.user_api_token.get(apiTokenId: my_api_token_id)
|
58
|
+
|
59
|
+
puts result
|
60
|
+
```
|
61
|
+
|
62
|
+
#### Authentication
|
63
|
+
The client must be configured with a valid api access token to call this
|
64
|
+
action. The token must include at least one of the following scopes:
|
65
|
+
all.User, all.User.read, userApiToken.*, or userApiToken.get.
|
66
|
+
|
67
|
+
#### Available Parameters
|
68
|
+
|
69
|
+
| Name | Type | Required | Description | Default | Example |
|
70
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
71
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
72
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
73
|
+
|
74
|
+
#### Successful Responses
|
75
|
+
|
76
|
+
| Code | Type | Description |
|
77
|
+
| ---- | ---- | ----------- |
|
78
|
+
| 200 | [API Token](_schemas.md#api-token) | API token information |
|
79
|
+
|
80
|
+
#### Error Responses
|
81
|
+
|
82
|
+
| Code | Type | Description |
|
83
|
+
| ---- | ---- | ----------- |
|
84
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
85
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|
86
|
+
|
87
|
+
<br/>
|
88
|
+
|
89
|
+
## Patch
|
90
|
+
|
91
|
+
Updates information about an API token
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
result = client.user_api_token.patch(
|
95
|
+
apiTokenId: my_api_token_id,
|
96
|
+
apiToken: my_api_token)
|
97
|
+
|
98
|
+
puts result
|
99
|
+
```
|
100
|
+
|
101
|
+
#### Authentication
|
102
|
+
The client must be configured with a valid api access token to call this
|
103
|
+
action. The token must include at least one of the following scopes:
|
104
|
+
all.User, userApiToken.*, or userApiToken.patch.
|
105
|
+
|
106
|
+
#### Available Parameters
|
107
|
+
|
108
|
+
| Name | Type | Required | Description | Default | Example |
|
109
|
+
| ---- | ---- | -------- | ----------- | ------- | ------- |
|
110
|
+
| apiTokenId | string | Y | ID associated with the API token | | 575ec7417ae143cd83dc4a95 |
|
111
|
+
| apiToken | [API Token Patch](_schemas.md#api-token-patch) | Y | Object containing new properties of the API token | | [API Token Patch Example](_schemas.md#api-token-patch-example) |
|
112
|
+
| losantdomain | string | N | Domain scope of request (rarely needed) | | example.com |
|
113
|
+
|
114
|
+
#### Successful Responses
|
115
|
+
|
116
|
+
| Code | Type | Description |
|
117
|
+
| ---- | ---- | ----------- |
|
118
|
+
| 200 | [API Token](_schemas.md#api-token) | Updated API token information |
|
119
|
+
|
120
|
+
#### Error Responses
|
121
|
+
|
122
|
+
| Code | Type | Description |
|
123
|
+
| ---- | ---- | ----------- |
|
124
|
+
| 400 | [Error](_schemas.md#error) | Error if malformed request |
|
125
|
+
| 404 | [Error](_schemas.md#error) | Error if API token was not found |
|