Auth

Authentication and authorization endpoints.

nonces

Introduced in version 1

Summary: POST /api/v1/snaps/auth/nonces

Return a nonce to request a device session.

Response JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "nonce": {
            "type": "string"
        }
    },
    "required": [
        "nonce"
    ],
    "type": "object"
}

sessions

Introduced in version 1

Summary: POST /api/v1/snaps/auth/sessions

Setup or refresh a device session.

If X-Device-Authorization is provided, it must be valid and a session refresh will be attempted.

Request JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "device-session-request": {
            "type": "string"
        },
        "model-assertion": {
            "type": "string"
        },
        "serial-assertion": {
            "type": "string"
        }
    },
    "required": [
        "serial-assertion",
        "device-session-request"
    ],
    "type": "object"
}

Response JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "macaroon": {
            "type": "string"
        }
    },
    "required": [
        "macaroon"
    ],
    "type": "object"
}

request_id

Introduced in version 1

Summary: POST /api/v1/snaps/auth/request-id

Returns a nonce that is needed for the 'serial' request.

request_id changelog

  • Version 6: Added support for device registration through Snap Store Proxy

Response JSON Schema

{
    "additionalProperties": false,
    "properties": {
        "request-id": {
            "type": "string"
        }
    },
    "required": [
        "request-id"
    ],
    "type": "object"
}

device_registration

Introduced in version 1

Summary: POST /api/v1/snaps/auth/devices

Register a device and return a (generic) serial assertion.

device_registration changelog

  • Version 6: Added support for device registration through Snap Store Proxy

© 2019 Canonical Ltd. Ubuntu and Canonical are registered trademarks of Canonical Ltd.