GitHub.App.Token

Documentation

generateInstallationToken :: MonadIO m => AppCredentials -> InstallationId -> m AccessToken

Generate a token for all repositories and the installation's permissions

See generateInstallationTokenScoped for changing either of these.

data AppCredentials

Constructors

AppCredentials

Fields

• appId :: AppId
• privateKey :: PrivateKey

newtype AppId

Constructors

AppId

Fields

• unwrap :: Int

newtype PrivateKey

Constructors

PrivateKey

Fields

• unwrap :: ByteString

Instances

Show PrivateKey

Defined in GitHub.App.Token.JWT

Methods

showsPrec :: Int -> PrivateKey -> ShowS

show :: PrivateKey -> String

showList :: [PrivateKey] -> ShowS

newtype InstallationId

Constructors

InstallationId

Fields

• unwrap :: Int

data AccessToken

Constructors

AccessToken

Fields

• token :: Text
• expires_at :: UTCTime

Instances

FromJSON AccessToken

Defined in GitHub.App.Token.Generate

Methods

parseJSON :: Value -> Parser AccessToken

parseJSONList :: Value -> Parser [AccessToken]

omittedField :: Maybe AccessToken

Generic AccessToken

Defined in GitHub.App.Token.Generate

Associated Types

type Rep AccessToken :: Type -> Type

Methods

from :: AccessToken -> Rep AccessToken x

to :: Rep AccessToken x -> AccessToken

Show AccessToken

Defined in GitHub.App.Token.Generate

Methods

showsPrec :: Int -> AccessToken -> ShowS

show :: AccessToken -> String

showList :: [AccessToken] -> ShowS

HasExpiresAt AccessToken

Defined in GitHub.App.Token.Refresh

Methods

expiresAt :: AccessToken -> UTCTime

type Rep AccessToken

Defined in GitHub.App.Token.Generate

type Rep AccessToken = D1 ('MetaData "AccessToken" "GitHub.App.Token.Generate" "github-app-token-0.0.2.0-2zJ8C3bSxtwJScDB0unpYX" 'False) (C1 ('MetaCons "AccessToken" 'PrefixI 'True) (S1 ('MetaSel ('Just "token") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "expires_at") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UTCTime)))

Scoped

data CreateAccessToken

https://docs.github.com/en/rest/apps/apps?apiVersion=2022-11-28#create-an-installation-access-token-for-an-app

Constructors

CreateAccessToken

Fields

• repositories :: [Text]

  List of {owner}/{name} values

• repository_ids :: [Int]
• permissions :: Permissions

Instances

ToJSON CreateAccessToken

Defined in GitHub.App.Token.Generate

Methods

toJSON :: CreateAccessToken -> Value

toEncoding :: CreateAccessToken -> Encoding

toJSONList :: [CreateAccessToken] -> Value

toEncodingList :: [CreateAccessToken] -> Encoding

omitField :: CreateAccessToken -> Bool

Monoid CreateAccessToken

Defined in GitHub.App.Token.Generate

Methods

mempty :: CreateAccessToken

mappend :: CreateAccessToken -> CreateAccessToken -> CreateAccessToken

mconcat :: [CreateAccessToken] -> CreateAccessToken

Semigroup CreateAccessToken

Defined in GitHub.App.Token.Generate

Methods

(<>) :: CreateAccessToken -> CreateAccessToken -> CreateAccessToken

sconcat :: NonEmpty CreateAccessToken -> CreateAccessToken

stimes :: Integral b => b -> CreateAccessToken -> CreateAccessToken

Generic CreateAccessToken

Defined in GitHub.App.Token.Generate

Associated Types

type Rep CreateAccessToken :: Type -> Type

Methods

from :: CreateAccessToken -> Rep CreateAccessToken x

to :: Rep CreateAccessToken x -> CreateAccessToken

Eq CreateAccessToken

Defined in GitHub.App.Token.Generate

Methods

(==) :: CreateAccessToken -> CreateAccessToken -> Bool

(/=) :: CreateAccessToken -> CreateAccessToken -> Bool

type Rep CreateAccessToken

Defined in GitHub.App.Token.Generate

type Rep CreateAccessToken = D1 ('MetaData "CreateAccessToken" "GitHub.App.Token.Generate" "github-app-token-0.0.2.0-2zJ8C3bSxtwJScDB0unpYX" 'False) (C1 ('MetaCons "CreateAccessToken" 'PrefixI 'True) (S1 ('MetaSel ('Just "repositories") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: (S1 ('MetaSel ('Just "repository_ids") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Int]) :*: S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Permissions))))

module GitHub.App.Token.Permissions

generateInstallationTokenScoped :: MonadIO m => CreateAccessToken -> AppCredentials -> InstallationId -> m AccessToken