broadmind-chainstream-root-api-eu-dev
Version: 2023-05-20T22:03:21Z
Security
broadmind-chainstream-semaphore-api-eu-dev
| apiKey | API Key |
|---|
| Name | Authorization |
| In | header |
| x-amazon-apigateway-authtype | custom |
broadmind-chainstream-root-eu-dev
| apiKey | API Key |
|---|
| Name | Authorization |
| In | header |
| x-amazon-apigateway-authtype | custom |
lambdaAuthorizer
| apiKey | API Key |
|---|
| Name | Authorization |
| In | header |
| x-amazon-apigateway-authtype | custom |
Schemes: https
/apikey/readKeys
GET
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| direction | query | | No | string |
| page | query | | No | string |
| orderBy | query | | No | string |
| startKey | query | | No | string |
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/apikey/upsertKey
POST
Parameters
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyUpsertResponse |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | ApikeyErrorResponse |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/auth/usernameGetToken
POST
Parameters
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthSessionTokenResponse |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | AuthErrorResponse |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/cognito
POST
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | CognitoErrorResponse |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/info
GET
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | |
| 400 | 400 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 401 | 401 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 403 | 403 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 404 | 404 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 409 | 409 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 500 | 500 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/info-auth
GET
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | |
| 400 | 400 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 401 | 401 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 403 | 403 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 404 | 404 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 409 | 409 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
| 500 | 500 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | ErrorResponse |
Security
| Security Schema | Scopes |
|---|
| lambdaAuthorizer | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/semaphore
GET
Summary
Returns a semaphore's settings
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| id | query | | No | string |
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
POST
Summary
Creates or updates a semaphore's settings. Omit the id in input to create a new semaphore.
Parameters
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/semaphore/list
GET
Summary
List semaphores. Use .startKey to page through results
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| startKey | query | | No | string |
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/semaphore/{semaphoreId}/acquire
POST
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| semaphoreId | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | 200 response |
| 400 | 400 response |
| 500 | 500 response |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-semaphore-api-eu-dev | |
/semaphore/{semaphoreId}/acquireSync
POST
Summary
Synchronously acquire a semaphore lock. Immediately returns either an acquired or rejected status.
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| semaphoreId | path | | Yes | string |
| SemaphoreLockRequest | body | | Yes | SemaphoreLockRequest |
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| semaphoreId | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/semaphore/{semaphoreId}/release
POST
Summary
Release a semaphore lock.
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| semaphoreId | path | | Yes | string |
| SemaphoreLockRequest | body | | Yes | SemaphoreLockRequest |
Responses
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| semaphoreId | path | | Yes | string |
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/user
GET
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| id | query | | No | string |
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserReadResponse |
| 400 | 400 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
| 401 | 401 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
| 403 | 403 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
| 404 | 404 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
| 409 | 409 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
| 500 | 500 responseHeaders:Cache-Control (string)Access-Control-Allow-Origin (string)Vary (string)Last-Modified (string)Content-Type (string) | UserErrorResponse |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
PUT
Parameters
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserReadResponse |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/user/activityStream
GET
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| after | query | | No | string |
| limit | query | | No | string |
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserAnyResponse |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
/user/current
GET
Parameters
| Name | Located in | Description | Required | Schema |
|---|
| id | query | | No | string |
Responses
| Code | Description | Schema |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserReadResponse |
| 400 | 400 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 401 | 401 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 403 | 403 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 404 | 404 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 409 | 409 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
| 500 | 500 responseHeaders:Access-Control-Allow-Origin (string)Content-Type (string) | UserErrorResponse |
Security
| Security Schema | Scopes |
|---|
| broadmind-chainstream-root-eu-dev | |
OPTIONS
Responses
| Code | Description |
|---|
| 200 | 200 responseHeaders:Access-Control-Allow-Origin (string)Access-Control-Allow-Methods (string)Access-Control-Allow-Headers (string) |
Models
ApikeyErrorResponse
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
AuthUsernameSessionTokenRequest
| Name | Type | Description | Required |
|---|
| password | string | | Yes |
| username | string | | Yes |
CognitoErrorResponse
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
ApikeyPagedListOwnerKeysResponse
| Name | Type | Description | Required |
|---|
| Items | [ { "owner": string, "maskKey": string, "reference": string, "lastUsed": number, "created": string, "totalUsed": number, "title": string, "isActive": boolean, "updated": string, "hash": string } ] | | No |
| Count | number | | No |
| ScannedCount | number | | No |
| LastEvaluatedKey | string | | No |
SemaphoreReadResponse
SemaphoreReadResponse Model
| Name | Type | Description | Required |
|---|
| owner | string | | No |
| created | string | | No |
| maxValue | number | | No |
| coverImage | string | | No |
| callback | string | | No |
| id | string | | No |
| title | string | | No |
| isActive | boolean | | No |
| updated | string | | No |
AuthSessionTokenResponse
| Name | Type | Description | Required |
|---|
| jwt | string | | No |
ApikeyUpsertRequest
| Name | Type | Description | Required |
|---|
| ApikeyUpsertRequest | | | |
SemaphoreSyncLockResponse
SemaphoreSyncLockResponse Model
| Name | Type | Description | Required |
|---|
| semaphoreId | string | | Yes |
| success | boolean | | No |
| channelId | string | | No |
SemaphorePagedSemaphoreListReadResponse
PagedSemaphoreListReadResponse Model
| Name | Type | Description | Required |
|---|
| Items | [ { "owner": string, "created": string, "maxValue": number, "coverImage": string, "callback": string, "id": string, "title": string, "isActive": boolean, "updated": string } ] | | No |
| Count | number | | No |
| ScannedCount | number | | No |
| LastEvaluatedKey | string | | No |
ErrorResponse
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
UserAnyResponse
| Name | Type | Description | Required |
|---|
| UserAnyResponse | object | | |
SemaphoreLockRequest
SemaphoreLockRequest Model
| Name | Type | Description | Required |
|---|
| channelId | string | | No |
SemaphoreUpsertRequest
SemaphoreUpsertRequest Model
| Name | Type | Description | Required |
|---|
| owner | string | | No |
| created | string | | No |
| maxValue | number | | No |
| coverImage | string | | No |
| callback | string | | No |
| id | string | | No |
| title | string | | No |
| isActive | boolean | | No |
| updated | string | | No |
ApikeyUpsertResponse
| Name | Type | Description | Required |
|---|
| ApikeyUpsertResponse | | | |
UserErrorResponse
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
AuthErrorResponse
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
SemaphoreErrorResponse
ErrorResponse Model
| Name | Type | Description | Required |
|---|
| errorMessage | string | | No |
| errorCode | string | | No |
| statusCode | number | | No |
SemaphoreOkResponse
OkResponse Model
| Name | Type | Description | Required |
|---|
| ok | boolean | | No |
UserReadResponse
| Name | Type | Description | Required |
|---|
| password | string | | No |
| phone | string | | No |
| permissions | string | | No |
| name | string | | No |
| id | string | | No |
| email | string | | No |
| account | string | | No |
| username | string | | No |
| status | string | | No |
UserUpdateRequest
| Name | Type | Description | Required |
|---|
| password | string | | No |
| phone | string | | No |
| permissions | string | | No |
| name | string | | No |
| id | string | | No |
| email | string | | No |
| account | string | | No |
| username | string | | No |
| status | string | | No |
