Account
Retrieves the collection of Account resources.
Authorizations
Query parameters
id[between]stringOptional
id[gt]stringOptional
id[gte]stringOptional
id[lt]stringOptional
id[lte]stringOptional
Responses
200
Account collection
get
GET /accounts HTTP/1.1
Host: api
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
200
Account collection
{
"hydra:member": [
{
"@id": "text",
"@type": "text",
"@context": "text",
"id": 1,
"providerId": 1,
"identifier": "text",
"externalUsername": "text",
"person": "/entitiy/1"
}
],
"hydra:totalItems": 1,
"hydra:view": {
"@id": "string",
"type": "string",
"hydra:first": "string",
"hydra:last": "string",
"hydra:previous": "string",
"hydra:next": "string"
},
"hydra:search": {
"@type": "text",
"hydra:template": "text",
"hydra:variableRepresentation": "text",
"hydra:mapping": [
{
"@type": "text",
"variable": "text",
"property": "text",
"required": true
}
]
}
}Creates a Account resource.
Authorizations
Body
LanceCoreAccount
@contextone ofRead-onlyOptional
stringOptional
@idstringRead-onlyOptional
@typestringRead-onlyOptional
providerIdintegerOptional
The provider id
identifierstringOptional
The account identifier
externalUsernamestringOptional
The account external username
personstring · iri-referenceOptional
The Person
passwordstringOptional
The account external username
Responses
201
Account resource created
400
Invalid input
422
Unprocessable entity
post
POST /accounts HTTP/1.1
Host: api
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/ld+json
Accept: */*
Content-Length: 102
{
"providerId": 1,
"identifier": "text",
"externalUsername": "text",
"person": "/entitiy/1",
"password": "text"
}{
"@context": "text",
"@id": "text",
"@type": "text"
}Retrieves a Account resource.
Authorizations
Path parameters
idstringRequired
Resource identifier
Responses
200
Account resource
404
Resource not found
get
GET /accounts/{id} HTTP/1.1
Host: api
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"@id": "text",
"@type": "text",
"@context": "text",
"id": 1,
"providerId": 1,
"identifier": "text",
"externalUsername": "text",
"person": "/entitiy/1"
}Removes the Account resource.
Authorizations
Path parameters
idstringRequired
Resource identifier
Responses
204
Account resource deleted
No content
404
Resource not found
delete
DELETE /accounts/{id} HTTP/1.1
Host: api
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Was this helpful?