jointrashposs/content/ja/.docs-legacy/api/endpoints/admin/show-users.json5
2023-07-11 23:48:17 +09:00

83 lines
1.2 KiB
Plaintext

{
summary: '',
description: '',
tags: [
'admin',
],
requireCredential: true,
req: {
type: 'object',
properties: {
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
},
offset: {
type: 'integer',
default: 0,
},
sort: {
type: 'string',
enum: [
'+follower',
'-follower',
'+createdAt',
'-createdAt',
'+updatedAt',
'-updatedAt',
],
},
state: {
type: 'string',
enum: [
'all',
'alive',
'available',
'admin',
'moderator',
'adminOrModerator',
'silenced',
'suspended',
],
default: 'all',
},
origin: {
type: 'string',
enum: [
'combined',
'local',
'remote',
],
default: 'combined',
},
username: {
type: 'string',
nullable: true,
default: null,
},
hostname: {
type: 'string',
nullable: true,
default: null,
description: 'The local host is represented with `null`.',
},
},
required: [],
},
res: {
type: 'array',
nullable: false,
optional: false,
items: {
type: 'object',
nullable: false,
optional: false,
ref: 'UserDetailed',
$ref: 'misskey://UserDetailed',
},
},
errors: {},
}