ai.newnal.pdn.server.createAppPassword

newnal-platform.newnal.id

Documentation

Create an App Password bound to an OAuth scope. Sessions created from it through com.atproto.server.createSession carry exactly the permissions of that scope, as an OAuth session would. Requires a full-access session.

main procedure

Create an App Password bound to an OAuth scope. Sessions created from it through com.atproto.server.createSession carry exactly the permissions of that scope, as an OAuth session would. Requires a full-access session.

Input

Encodingapplication/json
name string Required

A short name for the App Password, to help distinguish them.

privileged boolean Optional

If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients.

scope string Required

OAuth scope string (space separated; must include 'atproto'; may use include:<permission-set>).

Output

Encodingapplication/json
Schema#appPassword

Errors

AccountTakedown
InvalidScope
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Create an App Password bound to an OAuth scope. Sessions created from it through com.atproto.server.createSession carry exactly the permissions of that scope, as an OAuth session would. Requires a full-access session.",
  "errors": [
    {
      "name": "AccountTakedown"
    },
    {
      "name": "InvalidScope"
    }
  ],
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "name": {
          "description": "A short name for the App Password, to help distinguish them.",
          "type": "string"
        },
        "privileged": {
          "description": "If an app password has 'privileged' access to possibly sensitive account state. Meant for use with trusted clients.",
          "type": "boolean"
        },
        "scope": {
          "description": "OAuth scope string (space separated; must include 'atproto'; may use include:<permission-set>).",
          "type": "string"
        }
      },
      "required": [
        "name",
        "scope"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "ref": "#appPassword",
      "type": "ref"
    }
  },
  "type": "procedure"
}
appPassword object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

name string Required

No description available.

password string Required

No description available.

privileged boolean Optional

No description available.

scope string Required

No description available.

View raw schema 
{
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "privileged": {
      "type": "boolean"
    },
    "scope": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "password",
    "createdAt",
    "scope"
  ],
  "type": "object"
}

Lexicon Garden

@