You've already forked authentication-service
mirror of
https://github.com/matrix-org/matrix-authentication-service.git
synced 2025-07-29 22:01:14 +03:00
admin: list OAuth 2.0 sessions API
This commit is contained in:
Quentin Gliech
@ -16,6 +16,237 @@
|
||||
}
|
||||
],
|
||||
"paths": {
|
||||
"/api/admin/v1/oauth2-sessions": {
|
||||
"get": {
|
||||
"tags": [
|
||||
"oauth2-session"
|
||||
],
|
||||
"summary": "List OAuth 2.0 sessions",
|
||||
"description": "Retrieve a list of OAuth 2.0 sessions.\nNote that by default, all sessions, including finished ones are returned, with the oldest first.\nUse the `filter[status]` parameter to filter the sessions by their status and `page[last]` parameter to retrieve the last N sessions.",
|
||||
"operationId": "listOAuth2Sessions",
|
||||
"parameters": [
|
||||
{
|
||||
"in": "query",
|
||||
"name": "page[before]",
|
||||
"description": "Retrieve the items before the given ID",
|
||||
"schema": {
|
||||
"description": "Retrieve the items before the given ID",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "page[after]",
|
||||
"description": "Retrieve the items after the given ID",
|
||||
"schema": {
|
||||
"description": "Retrieve the items after the given ID",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "page[first]",
|
||||
"description": "Retrieve the first N items",
|
||||
"schema": {
|
||||
"description": "Retrieve the first N items",
|
||||
"type": "integer",
|
||||
"format": "uint",
|
||||
"minimum": 1.0,
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "page[last]",
|
||||
"description": "Retrieve the last N items",
|
||||
"schema": {
|
||||
"description": "Retrieve the last N items",
|
||||
"type": "integer",
|
||||
"format": "uint",
|
||||
"minimum": 1.0,
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter[user]",
|
||||
"description": "Retrieve the items for the given user",
|
||||
"schema": {
|
||||
"description": "Retrieve the items for the given user",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter[client]",
|
||||
"description": "Retrieve the items for the given client",
|
||||
"schema": {
|
||||
"description": "Retrieve the items for the given client",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter[user-session]",
|
||||
"description": "Retrieve the items started from the given browser session",
|
||||
"schema": {
|
||||
"description": "Retrieve the items started from the given browser session",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter[scope]",
|
||||
"description": "Retrieve the items with the given scope",
|
||||
"schema": {
|
||||
"description": "Retrieve the items with the given scope",
|
||||
"default": [],
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"style": "form"
|
||||
},
|
||||
{
|
||||
"in": "query",
|
||||
"name": "filter[status]",
|
||||
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all sessions, including finished ones.\n\n* `active`: Only retrieve active sessions\n\n* `finished`: Only retrieve finished sessions",
|
||||
"schema": {
|
||||
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all sessions, including finished ones.\n\n* `active`: Only retrieve active sessions\n\n* `finished`: Only retrieve finished sessions",
|
||||
"$ref": "#/components/schemas/OAuth2SessionStatus",
|
||||
"nullable": true
|
||||
},
|
||||
"style": "form"
|
||||
}
|
||||
],
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Paginated response of OAuth 2.0 sessions",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/PaginatedResponse_for_OAuth2Session"
|
||||
},
|
||||
"example": {
|
||||
"meta": {
|
||||
"count": 42
|
||||
},
|
||||
"data": [
|
||||
{
|
||||
"type": "oauth2-session",
|
||||
"id": "01040G2081040G2081040G2081",
|
||||
"attributes": {
|
||||
"created_at": "1970-01-01T00:00:00Z",
|
||||
"finished_at": null,
|
||||
"user_id": "02081040G2081040G2081040G2",
|
||||
"user_session_id": "030C1G60R30C1G60R30C1G60R3",
|
||||
"client_id": "040G2081040G2081040G208104",
|
||||
"scope": "openid",
|
||||
"user_agent": "Mozilla/5.0",
|
||||
"last_active_at": "1970-01-01T00:00:00Z",
|
||||
"last_active_ip": "127.0.0.1"
|
||||
},
|
||||
"links": {
|
||||
"self": "/api/admin/v1/oauth2-sessions/01040G2081040G2081040G2081"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "oauth2-session",
|
||||
"id": "02081040G2081040G2081040G2",
|
||||
"attributes": {
|
||||
"created_at": "1970-01-01T00:00:00Z",
|
||||
"finished_at": null,
|
||||
"user_id": null,
|
||||
"user_session_id": null,
|
||||
"client_id": "050M2GA1850M2GA1850M2GA185",
|
||||
"scope": "urn:mas:admin",
|
||||
"user_agent": null,
|
||||
"last_active_at": null,
|
||||
"last_active_ip": null
|
||||
},
|
||||
"links": {
|
||||
"self": "/api/admin/v1/oauth2-sessions/02081040G2081040G2081040G2"
|
||||
}
|
||||
},
|
||||
{
|
||||
"type": "oauth2-session",
|
||||
"id": "030C1G60R30C1G60R30C1G60R3",
|
||||
"attributes": {
|
||||
"created_at": "1970-01-01T00:00:00Z",
|
||||
"finished_at": "1970-01-01T00:00:00Z",
|
||||
"user_id": "040G2081040G2081040G208104",
|
||||
"user_session_id": "050M2GA1850M2GA1850M2GA185",
|
||||
"client_id": "060R30C1G60R30C1G60R30C1G6",
|
||||
"scope": "urn:matrix:org.matrix.msc2967.client:api:*",
|
||||
"user_agent": "Mozilla/5.0",
|
||||
"last_active_at": "1970-01-01T00:00:00Z",
|
||||
"last_active_ip": "127.0.0.1"
|
||||
},
|
||||
"links": {
|
||||
"self": "/api/admin/v1/oauth2-sessions/030C1G60R30C1G60R30C1G60R3"
|
||||
}
|
||||
}
|
||||
],
|
||||
"links": {
|
||||
"self": "/api/admin/v1/oauth2-sessions?page[first]=3",
|
||||
"first": "/api/admin/v1/oauth2-sessions?page[first]=3",
|
||||
"last": "/api/admin/v1/oauth2-sessions?page[last]=3",
|
||||
"next": "/api/admin/v1/oauth2-sessions?page[after]=030C1G60R30C1G60R30C1G60R3&page[first]=3"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"404": {
|
||||
"description": "User was not found",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
},
|
||||
"example": {
|
||||
"errors": [
|
||||
{
|
||||
"title": "User ID 00000000000000000000000000 not found"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"400": {
|
||||
"description": "Invalid scope",
|
||||
"content": {
|
||||
"application/json": {
|
||||
"schema": {
|
||||
"$ref": "#/components/schemas/ErrorResponse"
|
||||
},
|
||||
"example": {
|
||||
"errors": [
|
||||
{
|
||||
"title": "Invalid scope \"not a valid scope\" in filter parameters"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"/api/admin/v1/users": {
|
||||
"get": {
|
||||
"tags": [
|
||||
@ -743,29 +974,47 @@
|
||||
"type": "string",
|
||||
"pattern": "^[0123456789ABCDEFGHJKMNPQRSTVWXYZ]{26}$"
|
||||
},
|
||||
"UserFilter": {
|
||||
"OAuth2SessionFilter": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filter[can_request_admin]": {
|
||||
"description": "Retrieve users with (or without) the `can_request_admin` flag set",
|
||||
"type": "boolean",
|
||||
"filter[user]": {
|
||||
"description": "Retrieve the items for the given user",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"filter[client]": {
|
||||
"description": "Retrieve the items for the given client",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"filter[user-session]": {
|
||||
"description": "Retrieve the items started from the given browser session",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"filter[scope]": {
|
||||
"description": "Retrieve the items with the given scope",
|
||||
"default": [],
|
||||
"type": "array",
|
||||
"items": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"filter[status]": {
|
||||
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users",
|
||||
"$ref": "#/components/schemas/UserStatus",
|
||||
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all sessions, including finished ones.\n\n* `active`: Only retrieve active sessions\n\n* `finished`: Only retrieve finished sessions",
|
||||
"$ref": "#/components/schemas/OAuth2SessionStatus",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"UserStatus": {
|
||||
"OAuth2SessionStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"active",
|
||||
"locked"
|
||||
"finished"
|
||||
]
|
||||
},
|
||||
"PaginatedResponse_for_User": {
|
||||
"PaginatedResponse_for_OAuth2Session": {
|
||||
"description": "A top-level response with a page of resources",
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -782,7 +1031,7 @@
|
||||
"description": "The list of resources",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/SingleResource_for_User"
|
||||
"$ref": "#/components/schemas/SingleResource_for_OAuth2Session"
|
||||
}
|
||||
},
|
||||
"links": {
|
||||
@ -805,7 +1054,7 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"SingleResource_for_User": {
|
||||
"SingleResource_for_OAuth2Session": {
|
||||
"description": "A single resource, with its type, ID, attributes and related links",
|
||||
"type": "object",
|
||||
"required": [
|
||||
@ -825,7 +1074,7 @@
|
||||
},
|
||||
"attributes": {
|
||||
"description": "The attributes of the resource",
|
||||
"$ref": "#/components/schemas/User"
|
||||
"$ref": "#/components/schemas/OAuth2Session"
|
||||
},
|
||||
"links": {
|
||||
"description": "Related links",
|
||||
@ -833,33 +1082,60 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"User": {
|
||||
"description": "A user",
|
||||
"OAuth2Session": {
|
||||
"description": "A OAuth 2.0 session",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"can_request_admin",
|
||||
"client_id",
|
||||
"created_at",
|
||||
"username"
|
||||
"scope"
|
||||
],
|
||||
"properties": {
|
||||
"username": {
|
||||
"description": "The username (localpart) of the user",
|
||||
"type": "string"
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When the user was created",
|
||||
"description": "When the object was created",
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"locked_at": {
|
||||
"description": "When the user was locked. If null, the user is not locked.",
|
||||
"finished_at": {
|
||||
"description": "When the session was finished",
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"nullable": true
|
||||
},
|
||||
"can_request_admin": {
|
||||
"description": "Whether the user can request admin privileges.",
|
||||
"type": "boolean"
|
||||
"user_id": {
|
||||
"description": "The ID of the user who owns the session",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"user_session_id": {
|
||||
"description": "The ID of the browser session which started this session",
|
||||
"$ref": "#/components/schemas/ULID",
|
||||
"nullable": true
|
||||
},
|
||||
"client_id": {
|
||||
"description": "The ID of the client which requested this session",
|
||||
"$ref": "#/components/schemas/ULID"
|
||||
},
|
||||
"scope": {
|
||||
"description": "The scope granted for this session",
|
||||
"type": "string"
|
||||
},
|
||||
"user_agent": {
|
||||
"description": "The user agent string of the client which started this session",
|
||||
"type": "string",
|
||||
"nullable": true
|
||||
},
|
||||
"last_active_at": {
|
||||
"description": "The last time the session was active",
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"nullable": true
|
||||
},
|
||||
"last_active_ip": {
|
||||
"description": "The last IP address used by the session",
|
||||
"type": "string",
|
||||
"format": "ip",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
@ -938,6 +1214,112 @@
|
||||
}
|
||||
}
|
||||
},
|
||||
"UserFilter": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"filter[can_request_admin]": {
|
||||
"description": "Retrieve users with (or without) the `can_request_admin` flag set",
|
||||
"type": "boolean",
|
||||
"nullable": true
|
||||
},
|
||||
"filter[status]": {
|
||||
"description": "Retrieve the items with the given status\n\nDefaults to retrieve all users, including locked ones.\n\n* `active`: Only retrieve active users\n\n* `locked`: Only retrieve locked users",
|
||||
"$ref": "#/components/schemas/UserStatus",
|
||||
"nullable": true
|
||||
}
|
||||
}
|
||||
},
|
||||
"UserStatus": {
|
||||
"type": "string",
|
||||
"enum": [
|
||||
"active",
|
||||
"locked"
|
||||
]
|
||||
},
|
||||
"PaginatedResponse_for_User": {
|
||||
"description": "A top-level response with a page of resources",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"data",
|
||||
"links",
|
||||
"meta"
|
||||
],
|
||||
"properties": {
|
||||
"meta": {
|
||||
"description": "Response metadata",
|
||||
"$ref": "#/components/schemas/PaginationMeta"
|
||||
},
|
||||
"data": {
|
||||
"description": "The list of resources",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/components/schemas/SingleResource_for_User"
|
||||
}
|
||||
},
|
||||
"links": {
|
||||
"description": "Related links",
|
||||
"$ref": "#/components/schemas/PaginationLinks"
|
||||
}
|
||||
}
|
||||
},
|
||||
"SingleResource_for_User": {
|
||||
"description": "A single resource, with its type, ID, attributes and related links",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"attributes",
|
||||
"id",
|
||||
"links",
|
||||
"type"
|
||||
],
|
||||
"properties": {
|
||||
"type": {
|
||||
"description": "The type of the resource",
|
||||
"type": "string"
|
||||
},
|
||||
"id": {
|
||||
"description": "The ID of the resource",
|
||||
"$ref": "#/components/schemas/ULID"
|
||||
},
|
||||
"attributes": {
|
||||
"description": "The attributes of the resource",
|
||||
"$ref": "#/components/schemas/User"
|
||||
},
|
||||
"links": {
|
||||
"description": "Related links",
|
||||
"$ref": "#/components/schemas/SelfLinks"
|
||||
}
|
||||
}
|
||||
},
|
||||
"User": {
|
||||
"description": "A user",
|
||||
"type": "object",
|
||||
"required": [
|
||||
"can_request_admin",
|
||||
"created_at",
|
||||
"username"
|
||||
],
|
||||
"properties": {
|
||||
"username": {
|
||||
"description": "The username (localpart) of the user",
|
||||
"type": "string"
|
||||
},
|
||||
"created_at": {
|
||||
"description": "When the user was created",
|
||||
"type": "string",
|
||||
"format": "date-time"
|
||||
},
|
||||
"locked_at": {
|
||||
"description": "When the user was locked. If null, the user is not locked.",
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"nullable": true
|
||||
},
|
||||
"can_request_admin": {
|
||||
"description": "Whether the user can request admin privileges.",
|
||||
"type": "boolean"
|
||||
}
|
||||
}
|
||||
},
|
||||
"AddUserRequest": {
|
||||
"title": "JSON payload for the `POST /api/admin/v1/users` endpoint",
|
||||
"type": "object",
|
||||
|
||||
Reference in New Issue
Block a user