Getting started

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

To get started using the Access Keys Management API we need to create our first Access Key. This we need to do via the Sinch Build Dashboard.

Once we have secured our first Access Key we can then use it to create additional keys or revoke access for existing keys.

Exchange your Key ID and Key Secret found in the Sinch Build Dashboard for a bearer token (also known as the access_token).

$ curl https://auth.sinch.com/oauth2/token -d grant_type=client_credentials --user <key_id>:<key_secret>

{"access_token":"...","expires_in":3599,"scope":"","token_type":"bearer"}

Your access_token will be included in a successful response. The access token can be used as the bearer token in each call to the Access Key Management API.

The bearer token is valid for one hour.

Creating a new Access Key

Create a new access key by authenticating with an existing access key. Key ID and Secret are generated and returned. Once returned the first time, the secret cannot be viewed again. Ensure to save it somewhere secure for use.

$ curl https://account.api.sinch.com/v1/projects/{project_id}/accessKeys \
-H "Authorization: Bearer YOUR_access_token" \
-d '{
  "displayName": "My production Access key"
}'

{
  "accessKey": {
    "accessKeyId": "{accessKeyId}",
    "displayName": "My production Access key",
    "projectId": "{project_id}",
    "createTime": "2024-09-05T08:37:17.025Z",
    "updateTime": "2024-09-05T08:37:17.025Z",
  },
  "secret": "Q_qHBbB8Dfje..."
}

Deleting an Access Key

Delete an existing Access Key. No new access tokens can be generated for this key. Existing access token might be valid for up to 1 minute.

$ curl -X DELETE -H "Authorization: Bearer YOUR_access_token" \
https://account.api.sinch.com/v1/projects/{project_id}/accessKeys/{accessKeyId}