Skip to main content

ApplicationBotResponse

Detailed bot user metadata
FieldTypeDescription
authenticator_types?AuthenticatorType[]The types of authenticators enabled
avatar??stringThe avatar hash of the bot
banner??stringThe banner hash of the bot
bio?stringThe bio or description of the bot
discriminatorstringThe discriminator of the bot
flagsBotFlags
idSnowflakeTypeThe unique identifier of the bot user
mfa_enabled?booleanWhether the bot has MFA enabled
token?stringThe bot token for authentication
usernamestringThe username of the bot

ApplicationCreateRequest

Related endpoints
FieldTypeDescription
bot_public?booleanWhether the bot can be invited by anyone
bot_require_code_grant?booleanWhether the bot requires OAuth2 code grant
namestringThe name of the application
redirect_uris??OAuth2RedirectURICreateType[]The redirect URIs for OAuth2 flows

ApplicationFlags

The application flags Type: integer (int32)

ApplicationListResponse

Related endpoints Type: ApplicationResponse[]

ApplicationPublicResponse

Related endpoints
FieldTypeDescription
bot?ApplicationBotResponseThe bot user associated with the application
bot_publicbooleanWhether the bot can be invited by anyone
description?stringThe description of the application
icon?stringThe icon hash of the application
idSnowflakeTypeThe unique identifier of the application
namestringThe name of the application
redirect_urisstring[]The registered redirect URIs for OAuth2
scopesstring[]The available OAuth2 scopes

ApplicationResponse

Related endpoints
FieldTypeDescription
bot?ApplicationBotResponse
bot_publicbooleanWhether the bot can be invited by anyone
bot_require_code_grantbooleanWhether the bot requires OAuth2 code grant
client_secret?stringThe client secret for OAuth2 authentication
idSnowflakeTypeThe unique identifier of the application
namestringThe name of the application
redirect_urisstring[]The registered redirect URIs for OAuth2

ApplicationsMeResponse

Related endpoints
FieldTypeDescription
bot?ApplicationBotResponse
bot_publicbooleanWhether the bot can be invited by anyone
bot_require_code_grantbooleanWhether the bot requires OAuth2 code grant
description?stringThe description of the application
flagsApplicationFlags
icon?stringThe icon hash of the application
idSnowflakeTypeThe unique identifier of the application
namestringThe name of the application

ApplicationUpdateRequest

Related endpoints
FieldTypeDescription
bot_public?booleanWhether the bot can be invited by anyone
bot_require_code_grant?booleanWhether the bot requires OAuth2 code grant
name?stringThe name of the application
redirect_uris??OAuth2RedirectURIUpdateType[]The redirect URIs for OAuth2 flows

AuthorizeConsentRequest

Related endpoints
FieldTypeDescription
client_idSnowflakeType
guild_id?SnowflakeType
permissions?stringThe bot permissions to request
redirect_uri?stringThe URI to redirect to after authorization
response_type?stringThe OAuth2 response type
scopestringThe space-separated list of requested scopes
state?stringA random string for CSRF protection

BotFlags

The bot user flags Type: Bitflags32
FlagValueDescription
FRIENDLY_BOT16Bot accepts friend requests from users
FRIENDLY_BOT_MANUAL_APPROVAL32Bot requires manual approval for friend requests

BotProfileResponse

Related endpoints
FieldTypeDescription
avatar?stringThe avatar hash of the bot
banner?stringThe banner hash of the bot
bio?stringThe bio or description of the bot
discriminatorstringThe discriminator of the bot
idSnowflakeTypeThe unique identifier of the bot user
usernamestringThe username of the bot

BotProfileUpdateRequest

Related endpoints
FieldTypeDescription
avatar??Base64ImageTypeThe avatar image as base64
banner??Base64ImageTypeThe banner image as base64
bio??stringThe bio or description of the bot
bot_flags?BotFlags
discriminator?stringThe discriminator of the bot
username?UsernameType

BotTokenResetResponse

Related endpoints
FieldTypeDescription
botApplicationBotResponse
tokenstringThe new bot token

IntrospectRequestForm

Related endpoints
FieldTypeDescription
client_id?SnowflakeType
client_secret?stringThe application client secret
tokenstringThe token to introspect

OAuth2AuthorizationResponse

FieldTypeDescription
applicationOAuth2AuthorizationResponseApplicationThe application that was authorized
authorized_atstringThe timestamp when the authorization was granted
scopesstring[]The list of granted OAuth2 scopes

OAuth2AuthorizationsListResponse

Related endpoints Type: OAuth2AuthorizationResponse[]

OAuth2ConsentResponse

Related endpoints
FieldTypeDescription
redirect_tostringThe URL to redirect the user to after consent

OAuth2IntrospectResponse

Related endpoints
FieldTypeDescription
activebooleanWhether the token is currently active
client_id?SnowflakeType
exp?Int32Type
iat?Int32Type
scope?stringThe space-separated list of scopes
sub?SnowflakeType
token_type?stringThe type of token
username?stringThe username of the token owner

OAuth2MeResponse

Related endpoints
FieldTypeDescription
applicationOAuth2MeResponseApplicationThe application associated with the token
expiresstringThe expiration timestamp of the token
scopesstring[]The list of granted OAuth2 scopes
user?OAuth2MeResponseUserThe user associated with the token

OAuth2RedirectURICreateType

Type: string

OAuth2RedirectURIUpdateType

Type: string

OAuth2TokenResponse

Related endpoints
FieldTypeDescription
access_tokenstringThe access token for API authorization
expires_ininteger (int32)The number of seconds until the access token expires
refresh_tokenstringThe refresh token for obtaining new access tokens
scopestringThe space-separated list of granted scopes
token_typestringThe type of token, typically “Bearer”

OAuth2UserInfoResponse

Related endpoints
FieldTypeDescription
avatar?stringThe avatar hash of the user
discriminatorstringThe discriminator of the user
email??stringThe email address of the user
flags?PublicUserFlags
global_name?stringThe global display name of the user
idSnowflakeTypeThe unique identifier of the user
subSnowflakeTypeThe subject identifier of the user
usernamestringThe username of the user
verified??booleanWhether the user has verified their email

RevokeRequestForm

Related endpoints
FieldTypeDescription
client_id?SnowflakeType
client_secret?stringThe application client secret
tokenstringThe token to revoke
token_type_hint?RevokeRequestFormTokenTypeHintA hint about the type of token being revoked

TokenRequest

Related endpoints Type: TokenRequestOneOf0 | TokenRequestOneOf1

RevokeRequestFormTokenTypeHint

A hint about the type of token being revoked
ValueDescription
access_tokenAn OAuth2 access token
refresh_tokenAn OAuth2 refresh token

OAuth2AuthorizationResponseApplication

The application that was authorized
FieldTypeDescription
bot_publicbooleanWhether the bot can be invited by anyone
description?stringThe description of the application
icon?stringThe icon hash of the application
idSnowflakeTypeThe unique identifier of the application
namestringThe name of the application

OAuth2MeResponseApplication

The application associated with the token
FieldTypeDescription
bot_publicbooleanWhether the bot can be invited by anyone
bot_require_code_grantbooleanWhether the bot requires OAuth2 code grant
description?stringThe description of the application
flagsApplicationFlags
icon?stringThe icon hash of the application
idSnowflakeTypeThe unique identifier of the application
namestringThe name of the application

OAuth2MeResponseUser

The user associated with the token
FieldTypeDescription
avatar?stringThe avatar hash of the user
avatar_color?Int32TypeThe default avatar color of the user
bot?booleanWhether the user is a bot
discriminatorstringThe discriminator of the user
email??stringThe email address of the user
flagsPublicUserFlags
global_name?stringThe global display name of the user
idSnowflakeTypeThe unique identifier of the user
system?booleanWhether the user is a system user
usernamestringThe username of the user
verified??booleanWhether the user has verified their email

TokenRequestOneOf0

FieldTypeDescription
client_id?SnowflakeType
client_secret?stringThe application client secret
codestringThe authorization code received from the authorize endpoint
grant_typeenum<authorization_code>The grant type for exchanging an authorization code
redirect_uristringThe redirect URI used in the authorization request

TokenRequestOneOf1

FieldTypeDescription
client_id?SnowflakeType
client_secret?stringThe application client secret
grant_typeenum<refresh_token>The grant type for refreshing an access token
refresh_tokenstringThe refresh token to exchange for a new access token