Get login

  • Updated on Sep 3, 2025
  • Published on Sep 2, 2025
Prev Next
Get
/ds/login/{login_id}

Retrieve details of a specific data source login

Security
HTTP
Type bearer

Bearer token authentication. Include the token in the Authorization header: Authorization: Bearer <your-token>

Path parameters
login_id
stringRequired

Supermetrics login ID

Responses
200

Data source login details retrieved successfully

Expand All
object
meta
object
request_id
string

API request ID

data
object (DataSourceLogin)
@type
string
Valid values[ "ds_login" ]
login_id
string

Supermetrics login ID

login_type
string

Authentication type. Note that some data sources support multiple types, and user can choose between them.

username
string

Authenticated username, used in queries as ds_user

display_name
string

Visible name for this authentication in product UIs

ds_info
object (DataSource)
@type
string
Valid values[ "ds" ]
ds_id
string

Data source ID

name
string

Data source name

default_scopes
Array of string

List of default source API scopes used in authentication

string
additional_scopes
Array of string

List of additional source API scopes user has granted to access more data

string
auth_time
string (date-time)

ISO 8601 datetime for when last user authentication occurred

auth_user_info
object (User)
@type
string
Valid values[ "user" ]
user_id
string

Supermetrics user ID

email
string

Supermetrics user email

expiry_time
string (date-time) | null

ISO 8601 datetime for when authentication expires, if any

revoked_time
string (date-time) | null

ISO 8601 datetime for when authentication was revoked, if any

is_refreshable
boolean

Whether authentication can be automatically refreshed after expiry time, without user involvement

is_shared
boolean

Whether login is shared with all team users

404

Data Source Login Not Found

object
error
string
Valid values[ "LOGIN_NOT_FOUND" ]
message
string
500

Data Source Login Search Failed

object
error
string
Valid values[ "LOGIN_SEARCH_FAILED" ]
message
string