Skip to content

Service: OAuth2 Token List

Eliza Margaretha edited this page May 20, 2022 · 4 revisions

** WARNING: This service is experimental and may change without any notice.

lists all active access or refresh tokens of a user (not revoked, not expired), except the tokens from the requesting super client. This service is not part of the general OAuth2 specification. It is intended for use within an authorization server only, and only super clients are allowed to use this service. It requires user and super client authentications. If client_id is specified, only tokens granted to that client will be listed.

Available in: full version

Method: POST

Service URL: root/oauth2/token/list

Parameters

Header Parameters

Name Required Description Value
Authorization yes HTTP authentication with scheme: Bearer OAuth2 access token
Content-Type yes content type of the input data application/x-www-form-urlencoded

Request body URL-encoded form parameters

Name Required Description Type
super_client_id yes A super client identifier obtained from client registration. String
super_client_secret yes A super client secret obtained from client registration. String
token_type yes Defines which type of tokens to be listed: access_token or refresh_token String
client_id no A user client identifier. If specified, only tokens granted for this client would be listed. String

Examples

Request

curl -H 'Content-Type: application/x-www-form-urlencoded' 
     -H 'Authorization: Basic dXNlcm5hbWU6cGFzc3dvcmQ=' 
     -d 'super_client_id=fCBbQkA2YzIxYmY1Ng==&super_client_secret=
         Z0yTxWfoVPT3APmkU8mQoc7lyA9LvUm&token_type=refresh_token' 
     http://localhost:8089/api/v1.0/oauth2/token/list

Response

[
    {
        "token": "E1zpVmVl9Vbq3zBHo3EkMA",
        "created_date": "2019-11-21T10:58:44.277+01:00[Europe/Berlin]",
        "expires_in": "31535999",
        "user_authentication_time": "2019-11-21T10:58:44.201+01:00[Europe/Berlin]",
        "scopes": [
            "match_info",
            "search"
        ],
        "client_id": "8bIDtZnH6NvRkW2Fq",
        "client_name": "EasyPDF Exporter",
        "client_description": "EasyPDF is a tool for exporting data to PDF.",
        "client_url": "https://www.easypdf.org/"
    },
    {
        "token": "YwwpQj0vGRaVfV2-oI7huA",
        "created_date": "2019-11-21T10:58:44.375+01:00[Europe/Berlin]",
        "expires_in": "22961490",
        "user_authentication_time": "2019-11-21T10:58:44.329+01:00[Europe/Berlin]",
        "scopes": [
            "match_info",
            "search"
        ],
        "client_id": "9aHsGW6QflV13ixNpez",
        "client_name": "R statistical computing tool",
        "client_description": "R is a free software environment for statistical 
         computing and graphics.",
        "client_url": "https://www.r-project.org/"
    }
]

Advanced Setting

Developer Setting

Search services

Metadata services

Authentication and Authorization services

Client services

Super client services

Plugin services

User services

User group services

Virtual corpus services

Virtual corpus access services

Administrative services

Description services

Clone this wiki locally