Account

Retrieves the collection of Account resources.

get

Retrieves the collection of Account resources.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

id[between]stringOptional

id[gt]stringOptional

id[gte]stringOptional

id[lt]stringOptional

id[lte]stringOptional

Responses

200

Account collection

application/ld+jsontext/html

hydra:totalItemsintegerOptional

get

/api/accounts

HTTPcURLJavaScriptPython

GET /api/accounts HTTP/1.1
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.

post

Creates a Account resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/ld+jsontext/html

LanceCoreAccount

@contextone ofRead-onlyOptional

stringOptional

or

@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

application/ld+jsontext/html

400

Invalid input

422

Unprocessable entity

post

/api/accounts

HTTPcURLJavaScriptPython

POST /api/accounts HTTP/1.1
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"
}

application/ld+jsontext/html

{
  "@context": "text",
  "@id": "text",
  "@type": "text"
}

Retrieves a Account resource.

get

Retrieves a Account resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

200

Account resource

application/ld+jsontext/html

LanceCoreAccount

@idstringRead-onlyOptional

@typestringRead-onlyOptional

@contextone ofRead-onlyOptional

stringOptional

or

idintegerOptional

The unique identifier for the account entity

providerIdintegerOptional

The provider ID

identifierstringOptional

The account identifier

externalUsernamestringOptional

The account external username

personstring · iri-referenceOptional

The Person

404

Resource not found

get

/api/accounts/{id}

HTTPcURLJavaScriptPython

GET /api/accounts/{id} HTTP/1.1
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.

delete

Removes the Account resource.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Resource identifier

Responses

204

Account resource deleted

404

Resource not found

delete

/api/accounts/{id}

HTTPcURLJavaScriptPython

DELETE /api/accounts/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content