Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetProgrammaticAccessCredentials

Request programmatic credentials to use with FinSpace SDK.

Request Syntax


GET /credentials/programmatic?durationInMinutes=durationInMinutes&environmentId=environmentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

durationInMinutes

The time duration in which the credentials remain valid.

Valid Range: Minimum value of 60. Maximum value of 720.

environmentId

The FinSpace environment identifier.

Length Constraints: Minimum length of 1. Maximum length of 26.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "credentials": { 
      "accessKeyId": "string",
      "secretAccessKey": "string",
      "sessionToken": "string"
   },
   "durationInMinutes": number
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

credentials

Returns the programmatic credentials.

Type: Credentials object

durationInMinutes

Returns the duration in which the credentials will remain valid.

Type: Long

Valid Range: Minimum value of 60. Maximum value of 720.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

The request processing has failed because of an unknown error, exception or failure.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400