slackline/api/openid
This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.
Slack Web API methods for Sign in with Slack (OpenID Connect).
Types
Identifies openid.connect.token in the slackline.Call that
connect_token returns.
pub type ConnectToken
A successful response from openid.connect.token.
pub type ConnectTokenResponse {
ConnectTokenResponse(
access_token: option.Option(String),
token_type: option.Option(String),
id_token: option.Option(String),
refresh_token: option.Option(String),
expires_in: option.Option(Int),
)
}
Constructors
-
ConnectTokenResponse( access_token: option.Option(String), token_type: option.Option(String), id_token: option.Option(String), refresh_token: option.Option(String), expires_in: option.Option(Int), )Arguments
- access_token
-
The user token.
- token_type
-
The token type,
Bearer. - id_token
-
A JSON Web Token with the user’s identity claims.
- refresh_token
-
The refresh token, when token rotation is enabled.
- expires_in
-
Seconds until
access_tokenexpires, when token rotation is enabled.
Identifies openid.connect.userInfo in the slackline.Call that
connect_user_info returns.
pub type ConnectUserInfo
A successful response from openid.connect.userInfo.
pub type ConnectUserInfoResponse {
ConnectUserInfoResponse(
sub: option.Option(String),
user_id: option.Option(String),
team_id: option.Option(String),
email: option.Option(String),
email_verified: option.Option(Bool),
date_email_verified: option.Option(Int),
name: option.Option(String),
picture: option.Option(String),
given_name: option.Option(String),
family_name: option.Option(String),
locale: option.Option(String),
team_name: option.Option(String),
team_domain: option.Option(String),
user_image_24: option.Option(String),
user_image_32: option.Option(String),
user_image_48: option.Option(String),
user_image_72: option.Option(String),
user_image_192: option.Option(String),
user_image_512: option.Option(String),
user_image_1024: option.Option(String),
team_image_34: option.Option(String),
team_image_44: option.Option(String),
team_image_68: option.Option(String),
team_image_88: option.Option(String),
team_image_102: option.Option(String),
team_image_132: option.Option(String),
team_image_230: option.Option(String),
team_image_default: option.Option(Bool),
)
}
Constructors
-
ConnectUserInfoResponse( sub: option.Option(String), user_id: option.Option(String), team_id: option.Option(String), email: option.Option(String), email_verified: option.Option(Bool), date_email_verified: option.Option(Int), name: option.Option(String), picture: option.Option(String), given_name: option.Option(String), family_name: option.Option(String), locale: option.Option(String), team_name: option.Option(String), team_domain: option.Option(String), user_image_24: option.Option(String), user_image_32: option.Option(String), user_image_48: option.Option(String), user_image_72: option.Option(String), user_image_192: option.Option(String), user_image_512: option.Option(String), user_image_1024: option.Option(String), team_image_34: option.Option(String), team_image_44: option.Option(String), team_image_68: option.Option(String), team_image_88: option.Option(String), team_image_102: option.Option(String), team_image_132: option.Option(String), team_image_230: option.Option(String), team_image_default: option.Option(Bool), )Arguments
- sub
-
The subject: the user’s Slack ID.
- date_email_verified
-
Unix timestamp of when the email was verified.
- team_image_default
-
Whether the team image is a default one rather than an uploaded one.
Values
pub fn connect_token() -> slackline.Call(
ConnectToken,
ConnectTokenResponse,
)
openid.connect.token:
Exchanges a temporary OAuth verifier code for an access token for Sign in
with Slack.
openid.ConnectToken identifies this method in slackline.Call.
Set optional arguments with the functions in
slackline/api/openid/connect_token.
Rate limit tier: t4.
Documented errors: bad_client_secret, bad_redirect_uri,
cannot_install_an_org_installed_app, invalid_client,
invalid_client_id, invalid_code, invalid_grant, invalid_grant_type,
invalid_refresh_token, invalid_request,
oauth_authorization_url_mismatch, preview_feature_not_available,
unsupported_grant_type.
pub fn connect_token_response_decoder() -> decode.Decoder(
ConnectTokenResponse,
)
Decodes the response from openid.connect.token.
pub fn connect_user_info() -> slackline.Call(
ConnectUserInfo,
ConnectUserInfoResponse,
)
openid.connect.userInfo:
Get the identity of a user who has authorized Sign in with Slack.
openid.ConnectUserInfo identifies this method in slackline.Call.
User token scopes: openid.
Rate limit tier: t3.
pub fn connect_user_info_response_decoder() -> decode.Decoder(
ConnectUserInfoResponse,
)
Decodes the response from openid.connect.userInfo.