Summary
Get service accounts from the database.
Description
Get service accounts from the database.
Route
GET /oauth/serviceAccounts
Roles
admin
Parameters
Details Example Schema
Name
Type
Required
Description
queryOptions
object
yes
The query options for searching service accounts.
Copied to Clipboard
{
"queryOptions": {
"multiContains": {
"name": "ExampleName",
"description": "This is a service account for the external Example system"
},
"multiEquals": {
"name": "ExampleName",
"description": "This is a service account for the external Example system"
},
"multiStartsWith": {
"name": "ExampleName",
"description": "This is a service account for the external Example system"
},
"skip": 1,
"limit": 1,
"sort": "name",
"order": 1
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"queryOptions": {
"title": "queryOptions",
"type": "object",
"properties": {
"multiContains": {
"type": "object",
"properties": {
"name": {
"$ref": "service-accounts-schema#/definitions/name"
},
"description": {
"$ref": "service-accounts-schema#/definitions/description"
}
}
},
"multiEquals": {
"type": "object",
"properties": {
"name": {
"$ref": "service-accounts-schema#/definitions/name"
},
"description": {
"$ref": "service-accounts-schema#/definitions/description"
}
}
},
"multiStartsWith": {
"type": "object",
"properties": {
"name": {
"$ref": "service-accounts-schema#/definitions/name"
},
"description": {
"$ref": "service-accounts-schema#/definitions/description"
}
}
},
"skip": {
"$ref": "common-schema#/definitions/skip"
},
"limit": {
"$ref": "common-schema#/definitions/limit"
},
"sort": {
"$ref": "common-schema#/definitions/sort"
},
"order": {
"$ref": "common-schema#/definitions/order"
}
}
}
},
"required": [
"queryOptions"
],
"additionalProperties": false
}
Return
Details Example Schema
Name
Type
Description
result
object
The service accounts matching the specified query.
Copied to Clipboard
{
"results": [
{
"name": "ExampleName",
"description": "This is a service account for the external Example system",
"client_id": "5cb7b531d06cceb89fd21b1c",
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"createdBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "username@itential"
},
"updated": "2018-08-02T15:56:12.912Z",
"updatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "username@itential"
},
"secretUpdated": "2018-08-02T15:56:12.912Z"
}
},
{
"name": "ExampleName",
"description": "This is a service account for the external Example system",
"client_id": "5cb7b531d06cceb89fd21b1c",
"_meta": {
"created": "2018-08-02T15:56:12.912Z",
"createdBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "username@itential"
},
"updated": "2018-08-02T15:56:12.912Z",
"updatedBy": {
"_id": "5cb7b531d06cceb89fd21b1c",
"username": "username@itential"
},
"secretUpdated": "2018-08-02T15:56:12.912Z"
}
}
],
"total": 20
}
Copied to Clipboard
{
"title": "result",
"type": "object",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"$ref": "service-accounts-schema#/definitions/name"
},
"description": {
"$ref": "service-accounts-schema#/definitions/description"
},
"client_id": {
"$ref": "service-accounts-schema#/definitions/clientId"
},
"_meta": {
"type": "object",
"properties": {
"created": {
"$ref": "service-accounts-schema#/definitions/timestamp"
},
"createdBy": {
"$ref": "service-accounts-schema#/definitions/modifiedByDereferenced"
},
"updated": {
"$ref": "service-accounts-schema#/definitions/timestamp"
},
"updatedBy": {
"$ref": "service-accounts-schema#/definitions/modifiedByDereferenced"
},
"secretUpdated": {
"$ref": "service-accounts-schema#/definitions/timestamp"
}
}
}
}
}
},
"total": {
"$ref": "common-schema#/definitions/total"
}
}
}
