コンテンツにスキップ
Authrim

List database connection usage

GET
/api/admin/database-connections/{id}/usage
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/database-connections/example/usage \
  --header 'Authorization: Bearer <token>'

Lists registry rows or assignments that currently use the database connection.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Database connection ID.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Tenants or bindings using the database connection.

Media type application/json
object
items
required
Array<object>
object
id
string
connection_id
string
purpose
string
resource_type
string
resource_id
string
tenant_id
One of:
string
metadata
object
key
additional properties
created_by
One of:
string
created_at
integer
updated_at
integer
key
additional properties
total
required
integer
key
additional properties
Example 
{
  "items": [
    {
      "tenant_id": "tenant_123",
      "role": "tenant_pii",
      "binding_ref": "DB_PII",
      "connection_ref": "dbc_123",
      "status": "active",
      "created_at": 1770000000000,
      "updated_at": 1770000000000
    }
  ],
  "total": 1
}

default

Section titled “default ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}