DatoCMS client v0.2.3 DatoCMS.Client.Session

Summary

Functions

Calls POST /sessions

Functions

create(params)

Calls POST /sessions

params is JSON encoded and passed as the request body.

params Schema

{
  "additionalProperties": false,
  "properties": {
    "data": {
      "anyOf": [
        {
          "additionalProperties": false,
          "properties": {
            "attributes": {
              "additionalProperties": false,
              "description": "JSON API attributes",
              "properties": {
                "email": {
                  "description": "Email",
                  "example": "foo@bar.com",
                  "format": "email",
                  "type": "string"
                },
                "password": {
                  "description": "Password",
                  "example": "changeme",
                  "type": "string"
                }
              },
              "required": [
                "email",
                "password"
              ],
              "type": "object"
            },
            "type": {
              "description": "JSON API type field",
              "example": "email_credentials",
              "pattern": "^email_credentials$",
              "type": [
                "string"
              ]
            }
          },
          "required": [
            "type",
            "attributes"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "attributes": {
              "additionalProperties": false,
              "description": "JSON API attributes",
              "properties": {
                "password": {
                  "description": "Password",
                  "example": "changeme",
                  "type": "string"
                },
                "token": {
                  "description": "Invitation token",
                  "example": "XXXYYYZZZ",
                  "type": "string"
                }
              },
              "required": [
                "token",
                "password"
              ],
              "type": "object"
            },
            "type": {
              "description": "JSON API type field",
              "example": "password_reset",
              "pattern": "^password_reset$",
              "type": [
                "string"
              ]
            }
          },
          "required": [
            "type",
            "attributes"
          ],
          "type": "object"
        },
        {
          "additionalProperties": false,
          "properties": {
            "attributes": {
              "additionalProperties": false,
              "description": "JSON API attributes",
              "properties": {
                "password": {
                  "description": "Password",
                  "example": "changeme",
                  "type": "string"
                },
                "token": {
                  "description": "Invitation token",
                  "example": "XXXYYYZZZ",
                  "type": "string"
                }
              },
              "required": [
                "token",
                "password"
              ],
              "type": "object"
            },
            "type": {
              "description": "JSON API type field",
              "example": "invitation",
              "pattern": "^invitation$",
              "type": [
                "string"
              ]
            }
          },
          "required": [
            "type",
            "attributes"
          ],
          "type": "object"
        }
      ]
    }
  },
  "required": [
    "data"
  ],
  "type": "object"
}