Access Sessions

PreviousIntegrations NextAvailable Access

Last updated 6 days ago

Was this helpful?

List Access Sessions

get

Authorizations

Query parameters

integration_idstring[] | nullableOptional

limitinteger · int32OptionalDefault: 100

page_tokenstring | nullableOptional

request_idsstring[] | nullableOptional

Responses

200

application/json

get

GET /api/user/v1/access-sessions HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "items": [
    {
      "id": "text",
      "name": "text",
      "request_ids": [
        "text"
      ],
      "integration": {
        "id": "text",
        "name": "text"
      },
      "credentials_status": "text",
      "can_reset_credentials": true
    }
  ],
  "pagination": {
    "next_page_token": "text"
  }
}

Get Access Session

get

Authorizations

Path parameters

idstringRequired

Responses

200

application/json

get

GET /api/user/v1/access-sessions/{id} HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "id": "text",
  "name": "text",
  "request_ids": [
    "text"
  ],
  "integration": {
    "id": "text",
    "name": "text"
  },
  "credentials_status": "text",
  "can_reset_credentials": true
}

Get Session Access Details

get

Authorizations

Path parameters

idstringRequired

Responses

200

application/json

get

GET /api/user/v1/access-sessions/{id}/access-details HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "instructions": "text",
  "custom_admin_message": "text",
  "parameters": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "cli": "text",
  "link": {
    "url": "text",
    "title": "text"
  }
}

Reset Session Credentials

post

Authorizations

Path parameters

idstringRequired

Responses

200

application/json

post

POST /api/user/v1/access-sessions/{id}/reset-credentials HTTP/1.1
Host: api.apono.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

{
  "message": "text"
}