D
D
Documentation
Search…
latest

GET /appClients

Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>
Query name
Query value
nextToken
String value as returned by a previous list operation
maxResults
Integer representing maximum number of resources to list

Response body JSON Schema

1
{
2
"title": "appClients",
3
"required": [
4
"appClients",
5
"nextToken"
6
],
7
"type": "object",
8
"properties": {
9
"nextToken": {
10
"maxLength": 4096,
11
"type": "string",
12
"nullable": true
13
},
14
"appClients": {
15
"type": "array",
16
"items": {
17
"required": [
18
"apiKey",
19
"appClientId",
20
"callbackUrls",
21
"clientId",
22
"createdBy",
23
"createdTime",
24
"defaultLoginUrl",
25
"description",
26
"hasSecret",
27
"loginUrls",
28
"logoutUrls",
29
"name",
30
"updatedBy",
31
"updatedTime"
32
],
33
"type": "object",
34
"properties": {
35
"hasSecret": {
36
"type": "boolean"
37
},
38
"updatedTime": {
39
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
40
"type": "string",
41
"nullable": true
42
},
43
"clientId": {
44
"type": "string"
45
},
46
"updatedBy": {
47
"maxLength": 4096,
48
"type": "string",
49
"nullable": true
50
},
51
"apiKey": {
52
"maxLength": 4096,
53
"type": "string",
54
"nullable": true
55
},
56
"logoutUrls": {
57
"type": "array",
58
"items": {
59
"pattern": "^http://localhost.*|^https://.*",
60
"type": "string"
61
}
62
},
63
"description": {
64
"maxLength": 4096,
65
"type": "string",
66
"nullable": true
67
},
68
"callbackUrls": {
69
"type": "array",
70
"items": {
71
"pattern": "^http://localhost.*|^https://.*",
72
"type": "string"
73
}
74
},
75
"loginUrls": {
76
"type": "array",
77
"items": {
78
"pattern": "^http://localhost.*|^https://.*",
79
"type": "string"
80
}
81
},
82
"defaultLoginUrl": {
83
"pattern": "^http://localhost.*|^https://.*",
84
"type": "string",
85
"nullable": true
86
},
87
"createdBy": {
88
"maxLength": 4096,
89
"type": "string",
90
"nullable": true
91
},
92
"name": {
93
"maxLength": 4096,
94
"type": "string",
95
"nullable": true
96
},
97
"createdTime": {
98
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
99
"type": "string",
100
"nullable": true
101
},
102
"clientSecret": {
103
"type": "string"
104
},
105
"appClientId": {
106
"pattern": "^las:app-client:[a-f0-9]{32}quot;,
107
"type": "string"
108
}
109
},
110
"additionalProperties": false
111
}
112
}
113
},
114
"additionalProperties": false
115
}
Copied!

POST /appClients

Header name
Header value
Content-Type
application/json
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Request body JSON Schema

1
{
2
"title": "POST /appClients",
3
"type": "object",
4
"properties": {
5
"generateSecret": {
6
"type": "boolean",
7
"default": true
8
},
9
"logoutUrls": {
10
"type": "array",
11
"items": {
12
"pattern": "^http://localhost.*|^https://.*",
13
"type": "string"
14
}
15
},
16
"name": {
17
"maxLength": 4096,
18
"type": "string",
19
"nullable": true
20
},
21
"callbackUrls": {
22
"type": "array",
23
"items": {
24
"pattern": "^http://localhost.*|^https://.*",
25
"type": "string"
26
}
27
},
28
"description": {
29
"maxLength": 4096,
30
"type": "string",
31
"nullable": true
32
},
33
"loginUrls": {
34
"type": "array",
35
"items": {
36
"pattern": "^http://localhost.*|^https://.*",
37
"type": "string"
38
}
39
},
40
"defaultLoginUrl": {
41
"pattern": "^http://localhost.*|^https://.*",
42
"type": "string"
43
}
44
},
45
"additionalProperties": false
46
}
Copied!

Response body JSON Schema

1
{
2
"title": "appClient",
3
"required": [
4
"apiKey",
5
"appClientId",
6
"callbackUrls",
7
"clientId",
8
"createdBy",
9
"createdTime",
10
"defaultLoginUrl",
11
"description",
12
"hasSecret",
13
"loginUrls",
14
"logoutUrls",
15
"name",
16
"updatedBy",
17
"updatedTime"
18
],
19
"type": "object",
20
"properties": {
21
"hasSecret": {
22
"type": "boolean"
23
},
24
"updatedTime": {
25
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
26
"type": "string",
27
"nullable": true
28
},
29
"clientId": {
30
"type": "string"
31
},
32
"updatedBy": {
33
"maxLength": 4096,
34
"type": "string",
35
"nullable": true
36
},
37
"apiKey": {
38
"maxLength": 4096,
39
"type": "string",
40
"nullable": true
41
},
42
"logoutUrls": {
43
"type": "array",
44
"items": {
45
"pattern": "^http://localhost.*|^https://.*",
46
"type": "string"
47
}
48
},
49
"description": {
50
"maxLength": 4096,
51
"type": "string",
52
"nullable": true
53
},
54
"callbackUrls": {
55
"type": "array",
56
"items": {
57
"pattern": "^http://localhost.*|^https://.*",
58
"type": "string"
59
}
60
},
61
"loginUrls": {
62
"type": "array",
63
"items": {
64
"pattern": "^http://localhost.*|^https://.*",
65
"type": "string"
66
}
67
},
68
"defaultLoginUrl": {
69
"pattern": "^http://localhost.*|^https://.*",
70
"type": "string",
71
"nullable": true
72
},
73
"createdBy": {
74
"maxLength": 4096,
75
"type": "string",
76
"nullable": true
77
},
78
"name": {
79
"maxLength": 4096,
80
"type": "string",
81
"nullable": true
82
},
83
"createdTime": {
84
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
85
"type": "string",
86
"nullable": true
87
},
88
"clientSecret": {
89
"type": "string"
90
},
91
"appClientId": {
92
"pattern": "^las:app-client:[a-f0-9]{32}quot;,
93
"type": "string"
94
}
95
},
96
"additionalProperties": false
97
}
Copied!

DELETE /appClients/{appClientId}

Path name
Path value
appClientId
Id of appClient on the form las:appClient:<hex>
Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Response body JSON Schema

1
{
2
"title": "appClient",
3
"required": [
4
"apiKey",
5
"appClientId",
6
"callbackUrls",
7
"clientId",
8
"createdBy",
9
"createdTime",
10
"defaultLoginUrl",
11
"description",
12
"hasSecret",
13
"loginUrls",
14
"logoutUrls",
15
"name",
16
"updatedBy",
17
"updatedTime"
18
],
19
"type": "object",
20
"properties": {
21
"hasSecret": {
22
"type": "boolean"
23
},
24
"updatedTime": {
25
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
26
"type": "string",
27
"nullable": true
28
},
29
"clientId": {
30
"type": "string"
31
},
32
"updatedBy": {
33
"maxLength": 4096,
34
"type": "string",
35
"nullable": true
36
},
37
"apiKey": {
38
"maxLength": 4096,
39
"type": "string",
40
"nullable": true
41
},
42
"logoutUrls": {
43
"type": "array",
44
"items": {
45
"pattern": "^http://localhost.*|^https://.*",
46
"type": "string"
47
}
48
},
49
"description": {
50
"maxLength": 4096,
51
"type": "string",
52
"nullable": true
53
},
54
"callbackUrls": {
55
"type": "array",
56
"items": {
57
"pattern": "^http://localhost.*|^https://.*",
58
"type": "string"
59
}
60
},
61
"loginUrls": {
62
"type": "array",
63
"items": {
64
"pattern": "^http://localhost.*|^https://.*",
65
"type": "string"
66
}
67
},
68
"defaultLoginUrl": {
69
"pattern": "^http://localhost.*|^https://.*",
70
"type": "string",
71
"nullable": true
72
},
73
"createdBy": {
74
"maxLength": 4096,
75
"type": "string",
76
"nullable": true
77
},
78
"name": {
79
"maxLength": 4096,
80
"type": "string",
81
"nullable": true
82
},
83
"createdTime": {
84
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
85
"type": "string",
86
"nullable": true
87
},
88
"clientSecret": {
89
"type": "string"
90
},
91
"appClientId": {
92
"pattern": "^las:app-client:[a-f0-9]{32}quot;,
93
"type": "string"
94
}
95
},
96
"additionalProperties": false
97
}
Copied!

PATCH /appClients/{appClientId}

Path name
Path value
appClientId
Id of appClient on the form las:appClient:<hex>
Header name
Header value
Content-Type
application/json
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Request body JSON Schema

1
{
2
"title": "PATCH /appClients/{appClientId}",
3
"minProperties": 1,
4
"type": "object",
5
"properties": {
6
"name": {
7
"maxLength": 4096,
8
"type": "string",
9
"nullable": true
10
},
11
"description": {
12
"maxLength": 4096,
13
"type": "string",
14
"nullable": true
15
},
16
"loginUrls": {
17
"type": "array",
18
"items": {
19
"pattern": "^http://localhost.*|^https://.*",
20
"type": "string"
21
}
22
},
23
"defaultLoginUrl": {
24
"pattern": "^http://localhost.*|^https://.*",
25
"type": "string"
26
}
27
},
28
"additionalProperties": false
29
}
Copied!

Response body JSON Schema

1
{
2
"title": "appClient",
3
"required": [
4
"apiKey",
5
"appClientId",
6
"callbackUrls",
7
"clientId",
8
"createdBy",
9
"createdTime",
10
"defaultLoginUrl",
11
"description",
12
"hasSecret",
13
"loginUrls",
14
"logoutUrls",
15
"name",
16
"updatedBy",
17
"updatedTime"
18
],
19
"type": "object",
20
"properties": {
21
"hasSecret": {
22
"type": "boolean"
23
},
24
"updatedTime": {
25
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
26
"type": "string",
27
"nullable": true
28
},
29
"clientId": {
30
"type": "string"
31
},
32
"updatedBy": {
33
"maxLength": 4096,
34
"type": "string",
35
"nullable": true
36
},
37
"apiKey": {
38
"maxLength": 4096,
39
"type": "string",
40
"nullable": true
41
},
42
"logoutUrls": {
43
"type": "array",
44
"items": {
45
"pattern": "^http://localhost.*|^https://.*",
46
"type": "string"
47
}
48
},
49
"description": {
50
"maxLength": 4096,
51
"type": "string",
52
"nullable": true
53
},
54
"callbackUrls": {
55
"type": "array",
56
"items": {
57
"pattern": "^http://localhost.*|^https://.*",
58
"type": "string"
59
}
60
},
61
"loginUrls": {
62
"type": "array",
63
"items": {
64
"pattern": "^http://localhost.*|^https://.*",
65
"type": "string"
66
}
67
},
68
"defaultLoginUrl": {
69
"pattern": "^http://localhost.*|^https://.*",
70
"type": "string",
71
"nullable": true
72
},
73
"createdBy": {
74
"maxLength": 4096,
75
"type": "string",
76
"nullable": true
77
},
78
"name": {
79
"maxLength": 4096,
80
"type": "string",
81
"nullable": true
82
},
83
"createdTime": {
84
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
85
"type": "string",
86
"nullable": true
87
},
88
"clientSecret": {
89
"type": "string"
90
},
91
"appClientId": {
92
"pattern": "^las:app-client:[a-f0-9]{32}quot;,
93
"type": "string"
94
}
95
},
96
"additionalProperties": false
97
}
Copied!

GET /assets

Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>
Query name
Query value
nextToken
String value as returned by a previous list operation
maxResults
Integer representing maximum number of resources to list

Response body JSON Schema

1
{
2
"title": "assets",
3
"required": [
4
"assets",
5
"nextToken"
6
],
7
"type": "object",
8
"properties": {
9
"assets": {
10
"type": "array",
11
"items": {
12
"required": [
13
"assetId",
14
"createdBy",
15
"createdTime",
16
"description",
17
"name",
18
"updatedBy",
19
"updatedTime"
20
],
21
"type": "object",
22
"properties": {
23
"updatedTime": {
24
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
25
"type": "string",
26
"nullable": true
27
},
28
"updatedBy": {
29
"maxLength": 4096,
30
"type": "string",
31
"nullable": true
32
},
33
"createdBy": {
34
"maxLength": 4096,
35
"type": "string",
36
"nullable": true
37
},
38
"assetId": {
39
"pattern": "^las:asset:[a-f0-9]{32}quot;,
40
"type": "string"
41
},
42
"name": {
43
"maxLength": 4096,
44
"type": "string",
45
"nullable": true
46
},
47
"description": {
48
"maxLength": 4096,
49
"type": "string",
50
"nullable": true
51
},
52
"createdTime": {
53
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
54
"type": "string",
55
"nullable": true
56
},
57
"content": {
58
"minLength": 1,
59
"type": "string"
60
}
61
},
62
"additionalProperties": false
63
}
64
},
65
"nextToken": {
66
"maxLength": 4096,
67
"type": "string",
68
"nullable": true
69
}
70
},
71
"additionalProperties": false
72
}
Copied!

POST /assets

Header name
Header value
Content-Type
application/json
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Request body JSON Schema

1
{
2
"title": "POST /assets",
3
"required": [
4
"content"
5
],
6
"type": "object",
7
"properties": {
8
"name": {
9
"maxLength": 4096,
10
"type": "string",
11
"nullable": true
12
},
13
"description": {
14
"maxLength": 4096,
15
"type": "string",
16
"nullable": true
17
},
18
"content": {
19
"maxLength": 6250000,
20
"minLength": 1,
21
"type": "string"
22
}
23
},
24
"additionalProperties": false
25
}
Copied!

Response body JSON Schema

1
{
2
"title": "asset",
3
"required": [
4
"assetId",
5
"createdBy",
6
"createdTime",
7
"description",
8
"name",
9
"updatedBy",
10
"updatedTime"
11
],
12
"type": "object",
13
"properties": {
14
"updatedTime": {
15
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
16
"type": "string",
17
"nullable": true
18
},
19
"updatedBy": {
20
"maxLength": 4096,
21
"type": "string",
22
"nullable": true
23
},
24
"createdBy": {
25
"maxLength": 4096,
26
"type": "string",
27
"nullable": true
28
},
29
"assetId": {
30
"pattern": "^las:asset:[a-f0-9]{32}quot;,
31
"type": "string"
32
},
33
"name": {
34
"maxLength": 4096,
35
"type": "string",
36
"nullable": true
37
},
38
"description": {
39
"maxLength": 4096,
40
"type": "string",
41
"nullable": true
42
},
43
"createdTime": {
44
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
45
"type": "string",
46
"nullable": true
47
},
48
"content": {
49
"minLength": 1,
50
"type": "string"
51
}
52
},
53
"additionalProperties": false
54
}
Copied!

DELETE /assets/{assetId}

Path name
Path value
assetId
Id of asset on the form las:asset:<hex>
Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Response body JSON Schema

1
{
2
"title": "asset",
3
"required": [
4
"assetId",
5
"createdBy",
6
"createdTime",
7
"description",
8
"name",
9
"updatedBy",
10
"updatedTime"
11
],
12
"type": "object",
13
"properties": {
14
"updatedTime": {
15
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
16
"type": "string",
17
"nullable": true
18
},
19
"updatedBy": {
20
"maxLength": 4096,
21
"type": "string",
22
"nullable": true
23
},
24
"createdBy": {
25
"maxLength": 4096,
26
"type": "string",
27
"nullable": true
28
},
29
"assetId": {
30
"pattern": "^las:asset:[a-f0-9]{32}quot;,
31
"type": "string"
32
},
33
"name": {
34
"maxLength": 4096,
35
"type": "string",
36
"nullable": true
37
},
38
"description": {
39
"maxLength": 4096,
40
"type": "string",
41
"nullable": true
42
},
43
"createdTime": {
44
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
45
"type": "string",
46
"nullable": true
47
},
48
"content": {
49
"minLength": 1,
50
"type": "string"
51
}
52
},
53
"additionalProperties": false
54
}
Copied!

GET /assets/{assetId}

Path name
Path value
assetId
Id of asset on the form las:asset:<hex>
Header name
Header value
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Response body JSON Schema

1
{
2
"title": "asset",
3
"required": [
4
"assetId",
5
"createdBy",
6
"createdTime",
7
"description",
8
"name",
9
"updatedBy",
10
"updatedTime"
11
],
12
"type": "object",
13
"properties": {
14
"updatedTime": {
15
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
16
"type": "string",
17
"nullable": true
18
},
19
"updatedBy": {
20
"maxLength": 4096,
21
"type": "string",
22
"nullable": true
23
},
24
"createdBy": {
25
"maxLength": 4096,
26
"type": "string",
27
"nullable": true
28
},
29
"assetId": {
30
"pattern": "^las:asset:[a-f0-9]{32}quot;,
31
"type": "string"
32
},
33
"name": {
34
"maxLength": 4096,
35
"type": "string",
36
"nullable": true
37
},
38
"description": {
39
"maxLength": 4096,
40
"type": "string",
41
"nullable": true
42
},
43
"createdTime": {
44
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
45
"type": "string",
46
"nullable": true
47
},
48
"content": {
49
"minLength": 1,
50
"type": "string"
51
}
52
},
53
"additionalProperties": false
54
}
Copied!

PATCH /assets/{assetId}

Path name
Path value
assetId
Id of asset on the form las:asset:<hex>
Header name
Header value
Content-Type
application/json
Authorization
Bearer <your access token here>
x-api-key
<your api key here>

Request body JSON Schema

1
{
2
"title": "PATCH /assets/assetId",
3
"minProperties": 1,
4
"type": "object",
5
"properties": {
6
"name": {
7
"maxLength": 4096,
8
"type": "string",
9
"nullable": true
10
},
11
"description": {
12
"maxLength": 4096,
13
"type": "string",
14
"nullable": true
15
},
16
"content": {
17
"minLength": 1,
18
"type": "string"
19
}
20
},
21
"additionalProperties": false
22
}
Copied!

Response body JSON Schema

1
{
2
"title": "asset",
3
"required": [
4
"assetId",
5
"createdBy",
6
"createdTime",
7
"description",
8
"name",
9
"updatedBy",
10
"updatedTime"
11
],
12
"type": "object",
13
"properties": {
14
"updatedTime": {
15
"pattern": "^[0-9]{4}-?[0-9]{2}-?[0-9]{2}( |T)?[0-9]{2}:?[0-9]{2}:?[0-9]{2}(.[0-9]{1,6})?(Z|[+][0-9]{2}(:|)[0-9]{2})quot;,
16
"type": "string",
17
"nullable": true
18
},
19
"updatedBy": {
20
"maxLength": 4096,
21
"type": "string",
22
"nullable": true
23
},
24
"createdBy": {
25