Retrieve User API Key Private Preview

Returns the API key details for the specified service account.

Request schema

Path parameters

userId

stringrequired

The unique identifier for the user within the account.

example:

userId

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

string

default:

application/json

example:

application/json

Http + 1.1

GET

https://api.fivetran.com/v1/users/userId/api-keys

GET /v1/users/userId/api-keys HTTP/1.1
Accept: application/json
Authorization: Basic 
Host: api.fivetran.com

Responses

200

Successful response

404

User not found

`200`

code

stringrequired

Response status code

example:

Success

message

string

Response status text

example:

User API key has been retrieved

data

objectrequired

user_id

stringrequired

The unique identifier for the user within the Fivetran system.

example:

user_id

user_type

stringrequired

The type of user. Possible values: REGULAR_USER: A human user who can log in to the Fivetran dashboard and interact with the API, and SERVICE_ACCOUNT: A non-human identity for machine-to-machine API access that cannot log in to the dashboard.

enum:

"REGULAR_USER""SERVICE_ACCOUNT"

key_value

stringrequired

The public identifier of the API key.

example:

key_abc123

created_at

stringrequired

The timestamp that the user created their API key

format:

date-time

example:

2024-01-01T00:00:00Z

key_status

stringrequired

The status of the API key. Possible values: ACTIVE: The key has a single active secret, ACTIVE_GRACE: The key has two active secrets during rotation overlap, and EXPIRED: The key has expired.

enum:

"ACTIVE""ACTIVE_GRACE""EXPIRED"

expires_at

string

The timestamp when the API key expires.

format:

date-time

example:

2024-04-01T00:00:00Z

overlap_expires_at

string

The timestamp when the previous secret expires after rotation. Only present during the overlap period.

format:

date-time

example:

2024-03-08T00:00:00Z

last_rotated_at

string

format:

date-time

{
  "code": "Success",
  "message": "User API key has been retrieved",
  "data": {
    "user_id": "user_id",
    "user_type": "SERVICE_ACCOUNT",
    "key_value": "key_abc123",
    "created_at": "2024-01-01T00:00:00Z",
    "key_status": "ACTIVE",
    "expires_at": "2024-04-01T00:00:00Z",
    "overlap_expires_at": "2024-03-08T00:00:00Z",
    "last_rotated_at": "2019-08-24T14:15:22Z"
  }
}