com.atproto.server.getServiceAuth Documentation (EN)

main query

Get a signed token on behalf of the requesting DID for the requested service.

Parameters

aud string Required

The DID or `did#serviceId` reference of the service that the token will be used to authenticate with.

exp integer Optional

The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope.

lxm string nsid Optional

Lexicon (XRPC) method to bind the requested token to

Output

Encodingapplication/json

token string Required

No description available.

Errors

BadExpiration Indicates that the requested expiration date is not a valid. May be in the past or may be reliant on the requested scopes.

Try It

Direct PDS XRPC methods (com.atproto.*) are disabled in Try It for security reasons.

These methods interact directly with Personal Data Servers and require careful handling. Use a dedicated client or CLI tool instead.

View raw schema

{
  "description": "Get a signed token on behalf of the requesting DID for the requested service.",
  "errors": [
    {
      "description": "Indicates that the requested expiration date is not a valid. May be in the past or may be reliant on the requested scopes.",
      "name": "BadExpiration"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "token": {
          "type": "string"
        }
      },
      "required": [
        "token"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "aud": {
        "description": "The DID or `did#serviceId` reference of the service that the token will be used to authenticate with.",
        "maxLength": 2048,
        "type": "string"
      },
      "exp": {
        "description": "The time in Unix Epoch seconds that the JWT expires. Defaults to 60 seconds in the future. The service may enforce certain time bounds on tokens depending on the requested scope.",
        "type": "integer"
      },
      "lxm": {
        "description": "Lexicon (XRPC) method to bind the requested token to",
        "format": "nsid",
        "type": "string"
      }
    },
    "required": [
      "aud"
    ],
    "type": "params"
  },
  "type": "query"
}