Skip to navigation
Astropods APIDeployments

Authorize a deployment request

View as Markdown
Checks whether an inbound request to the calling deployment is allowed by its grants. The messaging container calls it, as does an agent that serves its own web UI. The token identifies the deployment. Identity fields are only returned when the request is allowed.

Authentication

AuthorizationBearer

The deployment’s token, injected into the agent as ASTRO_AUTHZ_TOKEN.

Query parameters

adapterstringRequired

The adapter handling the request: web, slack, or custom

identity_typestringOptional

user for a signed-in user, slack for a Slack user, or empty for anonymous

identity_idstringOptional

The user ID for identity_type; supply it with identity_type

identity_scopestringOptional

Disambiguates identity_id: the Slack team_id for slack, empty otherwise

Response

OK
allowedbooleanOptional
slack_team_idstringOptional

The Slack workspace ID from the request. Only present when allowed and identity_type is slack.

slack_user_idstringOptional

The Slack user ID from the request. Only present when allowed and identity_type is slack.

user_idstringOptional
Resolved platform user ID. Only present when allowed.

Errors

400
Bad Request Error
401
Unauthorized Error