Get Organization IoT Endpoint And Credentials

GET 
/organizations/:organizationId/iot-endpoint-and-credentials

Get Organization IoT Endpoint And Credentials

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Responses

200

application/json

Schema

Schema

data objectrequired
Data of the organization credentials.
awsRegion stringrequired
iotEndpoint stringrequired
credentials objectrequired
accessKeyId stringrequired
secretAccessKey stringrequired
sessionToken stringrequired
expiration stringrequired

Example (from schema)

{
  "data": {
    "awsRegion": "string",
    "iotEndpoint": "string",
    "credentials": {
      "accessKeyId": "string",
      "secretAccessKey": "string",
      "sessionToken": "string",
      "expiration": "string"
    }
  }
}

Example

{
  "data": {
    "iotEndpoint": "a3m4oxxxxxxxxxx-ats.iot.ap-northeast-1.amazonaws.com",
    "awsRegion": "ap-northeast-1",
    "credentials": {
      "accessKeyId": "ABCDEFGHIJKLMNOPQRST",
      "secretAccessKey": "p9+7+f/ABCDEFGHIJKLMNO/ABCDEFGHIJKLMNOPQ",
      "sessionToken": "ABCDEFGHIJKLMNOPQRS//////////",
      "expiration": "2024-01-01T00:00:00.000Z"
    }
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...