|
7936 | 7936 | "type": "integer" |
7937 | 7937 | }, |
7938 | 7938 | "grouping": { |
7939 | | - "description": "Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)", |
| 7939 | + "description": "Group by based on equal values (equal-values)", |
7940 | 7940 | "enum": [ |
7941 | | - "ASC", |
7942 | | - "DESC", |
7943 | 7941 | "equal-values" |
7944 | 7942 | ], |
7945 | 7943 | "type": "string" |
|
7948 | 7946 | } |
7949 | 7947 | }, |
7950 | 7948 | "sortBy": { |
7951 | | - "description": "By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.", |
| 7949 | + "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.", |
7952 | 7950 | "x-amf-union": [ |
7953 | 7951 | { |
7954 | 7952 | "type": "array", |
|
9918 | 9916 | }, |
9919 | 9917 | "/audit": { |
9920 | 9918 | "post": { |
9921 | | - "description": "Returns 1000 audit events with the nextToken parameter which can be passed back to the API to fetch subsequent logs. \n**Note:** This API is available for enterprise users only.", |
| 9919 | + "description": "Gathers the audit logs for a single day from a realm. By default, this API returns 10,000 entries. This can be changed with the numRows parameter. Integrators can iterate through batches to get an entire day's worth of logs. Each realm has a maximum entitlement of querying 1,000 days per year (allowing lookbacks for up to two years). Requests for paginated data do not count towards the annual limit. Transactional rate limits are 10 per 10 seconds.", |
9922 | 9920 | "summary": "Get audit logs", |
9923 | 9921 | "operationId": "audit", |
9924 | 9922 | "consumes": [ |
|
9965 | 9963 | "properties": { |
9966 | 9964 | "nextToken": { |
9967 | 9965 | "description": "Token specifying start of page. For first page don't supply this.", |
9968 | | - "example": "1000", |
| 9966 | + "example": "6a.f12x", |
9969 | 9967 | "type": "string" |
9970 | 9968 | }, |
| 9969 | + "numRows": { |
| 9970 | + "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.", |
| 9971 | + "example": 10000, |
| 9972 | + "type": "integer" |
| 9973 | + }, |
9971 | 9974 | "queryId": { |
9972 | 9975 | "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.", |
9973 | 9976 | "example": "c41aa90e-0db6-4732-8e22-2ef80fe4092a", |
|
10003 | 10006 | "time": "2020-04-21T14:41:51.886Z" |
10004 | 10007 | } |
10005 | 10008 | ], |
10006 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 10009 | + "nextToken": "6a.f12x", |
| 10010 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
10007 | 10011 | }, |
10008 | 10012 | "type": "object", |
10009 | 10013 | "additionalProperties": true, |
|
10138 | 10142 | "x-amf-mediaType": "application/json", |
10139 | 10143 | "schema": { |
10140 | 10144 | "example": { |
10141 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 10145 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
10142 | 10146 | }, |
10143 | 10147 | "type": "object", |
10144 | 10148 | "additionalProperties": true, |
|
20952 | 20956 | "type": "integer" |
20953 | 20957 | }, |
20954 | 20958 | "grouping": { |
20955 | | - "description": "Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)", |
| 20959 | + "description": "Group by based on equal values (equal-values)", |
20956 | 20960 | "enum": [ |
20957 | | - "ASC", |
20958 | | - "DESC", |
20959 | 20961 | "equal-values" |
20960 | 20962 | ], |
20961 | 20963 | "type": "string" |
|
20964 | 20966 | } |
20965 | 20967 | }, |
20966 | 20968 | "sortBy": { |
20967 | | - "description": "By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.", |
| 20969 | + "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.", |
20968 | 20970 | "x-amf-union": [ |
20969 | 20971 | { |
20970 | 20972 | "type": "array", |
|
21232 | 21234 | "type": "integer" |
21233 | 21235 | }, |
21234 | 21236 | "grouping": { |
21235 | | - "description": "Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)", |
| 21237 | + "description": "Group by based on equal values (equal-values)", |
21236 | 21238 | "enum": [ |
21237 | | - "ASC", |
21238 | | - "DESC", |
21239 | 21239 | "equal-values" |
21240 | 21240 | ], |
21241 | 21241 | "type": "string" |
|
21244 | 21244 | } |
21245 | 21245 | }, |
21246 | 21246 | "sortBy": { |
21247 | | - "description": "By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.", |
| 21247 | + "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.", |
21248 | 21248 | "x-amf-union": [ |
21249 | 21249 | { |
21250 | 21250 | "type": "array", |
|
24027 | 24027 | } |
24028 | 24028 | }, |
24029 | 24029 | { |
24030 | | - "description": "Returns 1000 audit events with the nextToken parameter which can be passed back to the API to fetch subsequent logs. \n**Note:** This API is available for enterprise users only.", |
| 24030 | + "description": "Gathers the audit logs for a single day from a realm. By default, this API returns 10,000 entries. This can be changed with the numRows parameter. Integrators can iterate through batches to get an entire day's worth of logs. Each realm has a maximum entitlement of querying 1,000 days per year (allowing lookbacks for up to two years). Requests for paginated data do not count towards the annual limit. Transactional rate limits are 10 per 10 seconds.", |
24031 | 24031 | "summary": "Get audit logs", |
24032 | 24032 | "operationId": "audit", |
24033 | 24033 | "consumes": [ |
|
24074 | 24074 | "properties": { |
24075 | 24075 | "nextToken": { |
24076 | 24076 | "description": "Token specifying start of page. For first page don't supply this.", |
24077 | | - "example": "1000", |
| 24077 | + "example": "6a.f12x", |
24078 | 24078 | "type": "string" |
24079 | 24079 | }, |
| 24080 | + "numRows": { |
| 24081 | + "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.", |
| 24082 | + "example": 10000, |
| 24083 | + "type": "integer" |
| 24084 | + }, |
24080 | 24085 | "queryId": { |
24081 | 24086 | "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.", |
24082 | 24087 | "example": "c41aa90e-0db6-4732-8e22-2ef80fe4092a", |
|
24112 | 24117 | "time": "2020-04-21T14:41:51.886Z" |
24113 | 24118 | } |
24114 | 24119 | ], |
24115 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 24120 | + "nextToken": "6a.f12x", |
| 24121 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
24116 | 24122 | }, |
24117 | 24123 | "type": "object", |
24118 | 24124 | "additionalProperties": true, |
|
24247 | 24253 | "x-amf-mediaType": "application/json", |
24248 | 24254 | "schema": { |
24249 | 24255 | "example": { |
24250 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 24256 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
24251 | 24257 | }, |
24252 | 24258 | "type": "object", |
24253 | 24259 | "additionalProperties": true, |
|
24311 | 24317 | "properties": { |
24312 | 24318 | "nextToken": { |
24313 | 24319 | "description": "Token specifying start of page. For first page don't supply this.", |
24314 | | - "example": "1000", |
| 24320 | + "example": "6a.f12x", |
24315 | 24321 | "type": "string" |
24316 | 24322 | }, |
| 24323 | + "numRows": { |
| 24324 | + "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.", |
| 24325 | + "example": 10000, |
| 24326 | + "type": "integer" |
| 24327 | + }, |
24317 | 24328 | "queryId": { |
24318 | 24329 | "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.", |
24319 | 24330 | "example": "c41aa90e-0db6-4732-8e22-2ef80fe4092a", |
|
35173 | 35184 | "type": "integer" |
35174 | 35185 | }, |
35175 | 35186 | "grouping": { |
35176 | | - "description": "Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)", |
| 35187 | + "description": "Group by based on equal values (equal-values)", |
35177 | 35188 | "enum": [ |
35178 | | - "ASC", |
35179 | | - "DESC", |
35180 | 35189 | "equal-values" |
35181 | 35190 | ], |
35182 | 35191 | "type": "string" |
|
35185 | 35194 | } |
35186 | 35195 | }, |
35187 | 35196 | "sortBy": { |
35188 | | - "description": "By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.", |
| 35197 | + "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.", |
35189 | 35198 | "x-amf-union": [ |
35190 | 35199 | { |
35191 | 35200 | "type": "array", |
|
35453 | 35462 | "type": "integer" |
35454 | 35463 | }, |
35455 | 35464 | "grouping": { |
35456 | | - "description": "Group by based on ascending order (ASC), descending order (DESC) or equal values (equal-values)", |
| 35465 | + "description": "Group by based on equal values (equal-values)", |
35457 | 35466 | "enum": [ |
35458 | | - "ASC", |
35459 | | - "DESC", |
35460 | 35467 | "equal-values" |
35461 | 35468 | ], |
35462 | 35469 | "type": "string" |
|
35465 | 35472 | } |
35466 | 35473 | }, |
35467 | 35474 | "sortBy": { |
35468 | | - "description": "By default, queries will be sorted by the given sort fields or the default sort if the query does not provide any. Set to false to avoid sorting when the order of the data returned is not important. Returning data without sorting can improve performance.", |
| 35475 | + "description": "An array of field IDs and sort directions. If this attribute is not set or set to false, queries will be unsorted to improve performance.", |
35469 | 35476 | "x-amf-union": [ |
35470 | 35477 | { |
35471 | 35478 | "type": "array", |
|
38258 | 38265 | ], |
38259 | 38266 | "Audit": [ |
38260 | 38267 | { |
38261 | | - "description": "Returns 1000 audit events with the nextToken parameter which can be passed back to the API to fetch subsequent logs. \n**Note:** This API is available for enterprise users only.", |
| 38268 | + "description": "Gathers the audit logs for a single day from a realm. By default, this API returns 10,000 entries. This can be changed with the numRows parameter. Integrators can iterate through batches to get an entire day's worth of logs. Each realm has a maximum entitlement of querying 1,000 days per year (allowing lookbacks for up to two years). Requests for paginated data do not count towards the annual limit. Transactional rate limits are 10 per 10 seconds.", |
38262 | 38269 | "summary": "Get audit logs", |
38263 | 38270 | "operationId": "audit", |
38264 | 38271 | "consumes": [ |
|
38305 | 38312 | "properties": { |
38306 | 38313 | "nextToken": { |
38307 | 38314 | "description": "Token specifying start of page. For first page don't supply this.", |
38308 | | - "example": "1000", |
| 38315 | + "example": "6a.f12x", |
38309 | 38316 | "type": "string" |
38310 | 38317 | }, |
| 38318 | + "numRows": { |
| 38319 | + "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.", |
| 38320 | + "example": 10000, |
| 38321 | + "type": "integer" |
| 38322 | + }, |
38311 | 38323 | "queryId": { |
38312 | 38324 | "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.", |
38313 | 38325 | "example": "c41aa90e-0db6-4732-8e22-2ef80fe4092a", |
|
38343 | 38355 | "time": "2020-04-21T14:41:51.886Z" |
38344 | 38356 | } |
38345 | 38357 | ], |
38346 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 38358 | + "nextToken": "6a.f12x", |
| 38359 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
38347 | 38360 | }, |
38348 | 38361 | "type": "object", |
38349 | 38362 | "additionalProperties": true, |
|
38478 | 38491 | "x-amf-mediaType": "application/json", |
38479 | 38492 | "schema": { |
38480 | 38493 | "example": { |
38481 | | - "queryId": "797c0726-f8f4-4df9-883f-c7e8cbdf2f77.ALtInpuyQeBoW+fWrAqLrjPGqDqPl++IMb3bOxlmoF4=" |
| 38494 | + "queryId": "jCB5QMWZc4a4F9l4yl0Xs6N0onYvQ9m8jSKx6934pv8=.bsz8kniab" |
38482 | 38495 | }, |
38483 | 38496 | "type": "object", |
38484 | 38497 | "additionalProperties": true, |
|
38542 | 38555 | "properties": { |
38543 | 38556 | "nextToken": { |
38544 | 38557 | "description": "Token specifying start of page. For first page don't supply this.", |
38545 | | - "example": "1000", |
| 38558 | + "example": "6a.f12x", |
38546 | 38559 | "type": "string" |
38547 | 38560 | }, |
| 38561 | + "numRows": { |
| 38562 | + "description": "Number of logs to return per page, default is 10000, minimum is 1000, max is 50000.", |
| 38563 | + "example": 10000, |
| 38564 | + "type": "integer" |
| 38565 | + }, |
38548 | 38566 | "queryId": { |
38549 | 38567 | "description": "The query id of an audit log request. This id is needed to fetch subsequent paged results of a single query.", |
38550 | 38568 | "example": "c41aa90e-0db6-4732-8e22-2ef80fe4092a", |
|
0 commit comments