Safe Haskell	Safe-Inferred
Language	GHC2021

GitHub.App.Token.Generate

Contents

Finding installations by owner
Scoping AccessTokens
Errors

Synopsis

newtype InstallationId = InstallationId {
- unwrap :: Int
}
data AccessToken = AccessToken {
- token :: Text
- expires_at :: UTCTime
}
generateInstallationToken :: MonadIO m => AppCredentials -> InstallationId -> m AccessToken
data Owner
- = Org Text
- | User Text
generateOwnerToken :: MonadIO m => AppCredentials -> Owner -> m AccessToken
data CreateAccessToken = CreateAccessToken {
- repositories :: [Text]
- repository_ids :: [Int]
- permissions :: Permissions
}
module GitHub.App.Token.Permissions
generateInstallationTokenScoped :: MonadIO m => CreateAccessToken -> AppCredentials -> InstallationId -> m AccessToken
generateOwnerTokenScoped :: MonadIO m => CreateAccessToken -> AppCredentials -> Owner -> m AccessToken
newtype InvalidPrivateKey = InvalidPrivateKey PrivateKey
data InvalidDate = InvalidDate {
- field :: String
- date :: UTCTime
}
newtype InvalidIssuer = InvalidIssuer Issuer
data AccessTokenHttpError = AccessTokenHttpError {
- status :: Status
- body :: ByteString
}
data AccessTokenJsonDecodeError = AccessTokenJsonDecodeError {
- body :: ByteString
- message :: String
}
data GetInstallationHttpError = GetInstallationHttpError {
- status :: Status
- body :: ByteString
}
data GetInstallationJsonDecodeError = GetInstallationJsonDecodeError {
- body :: ByteString
- message :: String
}

Documentation

newtype InstallationId Source #

Constructors

InstallationId
Fields unwrap :: Int

Instances

Instances details

FromJSON InstallationId Source #
Instance details Defined in GitHub.App.Token.Generate Methods parseJSON :: Value -> Parser InstallationId # parseJSONList :: Value -> Parser [InstallationId] # omittedField :: Maybe InstallationId #

data AccessToken Source #

Constructors

AccessToken
Fields token :: Text expires_at :: UTCTime

Instances

Instances details

FromJSON AccessToken Source #
Instance details Defined in GitHub.App.Token.Generate Methods parseJSON :: Value -> Parser AccessToken # parseJSONList :: Value -> Parser [AccessToken] # omittedField :: Maybe AccessToken #
Generic AccessToken Source #
Instance details 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 Source #
Instance details Defined in GitHub.App.Token.Generate Methods showsPrec :: Int -> AccessToken -> ShowS # show :: AccessToken -> String # showList :: [AccessToken] -> ShowS #
HasExpiresAt AccessToken Source #
Instance details Defined in GitHub.App.Token.Refresh Methods expiresAt :: AccessToken -> UTCTime Source #
type Rep AccessToken Source #
Instance details Defined in GitHub.App.Token.Generate type Rep AccessToken = D1 ('MetaData "AccessToken" "GitHub.App.Token.Generate" "github-app-token-0.0.3.0-ClVzqKvHRdC7Dyt05IZ9Y1" '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)))

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

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

See generateInstallationTokenScoped for changing either of these.

Finding installations by owner

data Owner Source #

Constructors

Org Text
User Text

generateOwnerToken :: MonadIO m => AppCredentials -> Owner -> m AccessToken Source #

Scoping `AccessToken`s

data CreateAccessToken Source #

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

Instances details

ToJSON CreateAccessToken Source #
Instance details Defined in GitHub.App.Token.Generate Methods toJSON :: CreateAccessToken -> Value # toEncoding :: CreateAccessToken -> Encoding # toJSONList :: [CreateAccessToken] -> Value # toEncodingList :: [CreateAccessToken] -> Encoding # omitField :: CreateAccessToken -> Bool #
Monoid CreateAccessToken Source #
Instance details Defined in GitHub.App.Token.Generate Methods mempty :: CreateAccessToken # mappend :: CreateAccessToken -> CreateAccessToken -> CreateAccessToken # mconcat :: [CreateAccessToken] -> CreateAccessToken #
Semigroup CreateAccessToken Source #
Instance details Defined in GitHub.App.Token.Generate Methods (<>) :: CreateAccessToken -> CreateAccessToken -> CreateAccessToken # sconcat :: NonEmpty CreateAccessToken -> CreateAccessToken # stimes :: Integral b => b -> CreateAccessToken -> CreateAccessToken #
Generic CreateAccessToken Source #
Instance details 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 Source #
Instance details Defined in GitHub.App.Token.Generate Methods (==) :: CreateAccessToken -> CreateAccessToken -> Bool # (/=) :: CreateAccessToken -> CreateAccessToken -> Bool #
type Rep CreateAccessToken Source #
Instance details Defined in GitHub.App.Token.Generate type Rep CreateAccessToken = D1 ('MetaData "CreateAccessToken" "GitHub.App.Token.Generate" "github-app-token-0.0.3.0-ClVzqKvHRdC7Dyt05IZ9Y1" '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 Source #

generateOwnerTokenScoped :: MonadIO m => CreateAccessToken -> AppCredentials -> Owner -> m AccessToken Source #

Errors

newtype InvalidPrivateKey Source #

Constructors

InvalidPrivateKey PrivateKey

Instances

Instances details

Exception InvalidPrivateKey Source #
Instance details Defined in GitHub.App.Token.JWT Methods toException :: InvalidPrivateKey -> SomeException # fromException :: SomeException -> Maybe InvalidPrivateKey # displayException :: InvalidPrivateKey -> String #
Show InvalidPrivateKey Source #
Instance details Defined in GitHub.App.Token.JWT Methods showsPrec :: Int -> InvalidPrivateKey -> ShowS # show :: InvalidPrivateKey -> String # showList :: [InvalidPrivateKey] -> ShowS #

data InvalidDate Source #

Constructors

InvalidDate
Fields field :: String date :: UTCTime

Instances

Instances details

Exception InvalidDate Source #
Instance details Defined in GitHub.App.Token.JWT Methods toException :: InvalidDate -> SomeException # fromException :: SomeException -> Maybe InvalidDate # displayException :: InvalidDate -> String #
Show InvalidDate Source #
Instance details Defined in GitHub.App.Token.JWT Methods showsPrec :: Int -> InvalidDate -> ShowS # show :: InvalidDate -> String # showList :: [InvalidDate] -> ShowS #

newtype InvalidIssuer Source #

Constructors

InvalidIssuer Issuer

Instances

Instances details

Exception InvalidIssuer Source #
Instance details Defined in GitHub.App.Token.JWT Methods toException :: InvalidIssuer -> SomeException # fromException :: SomeException -> Maybe InvalidIssuer # displayException :: InvalidIssuer -> String #
Show InvalidIssuer Source #
Instance details Defined in GitHub.App.Token.JWT Methods showsPrec :: Int -> InvalidIssuer -> ShowS # show :: InvalidIssuer -> String # showList :: [InvalidIssuer] -> ShowS #

data AccessTokenHttpError Source #

Constructors

AccessTokenHttpError
Fields status :: Status body :: ByteString

Instances

Instances details

Exception AccessTokenHttpError Source #
Instance details Defined in GitHub.App.Token.Generate Methods toException :: AccessTokenHttpError -> SomeException # fromException :: SomeException -> Maybe AccessTokenHttpError # displayException :: AccessTokenHttpError -> String #
Show AccessTokenHttpError Source #
Instance details Defined in GitHub.App.Token.Generate Methods showsPrec :: Int -> AccessTokenHttpError -> ShowS # show :: AccessTokenHttpError -> String # showList :: [AccessTokenHttpError] -> ShowS #

data AccessTokenJsonDecodeError Source #

Constructors

AccessTokenJsonDecodeError
Fields body :: ByteString message :: String

Instances

Instances details

Exception AccessTokenJsonDecodeError Source #
Instance details Defined in GitHub.App.Token.Generate Methods toException :: AccessTokenJsonDecodeError -> SomeException # fromException :: SomeException -> Maybe AccessTokenJsonDecodeError # displayException :: AccessTokenJsonDecodeError -> String #
Show AccessTokenJsonDecodeError Source #
Instance details Defined in GitHub.App.Token.Generate Methods showsPrec :: Int -> AccessTokenJsonDecodeError -> ShowS # show :: AccessTokenJsonDecodeError -> String # showList :: [AccessTokenJsonDecodeError] -> ShowS #

data GetInstallationHttpError Source #

Constructors

GetInstallationHttpError
Fields status :: Status body :: ByteString

Instances

Instances details

Exception GetInstallationHttpError Source #
Instance details Defined in GitHub.App.Token.Generate Methods toException :: GetInstallationHttpError -> SomeException # fromException :: SomeException -> Maybe GetInstallationHttpError # displayException :: GetInstallationHttpError -> String #
Show GetInstallationHttpError Source #
Instance details Defined in GitHub.App.Token.Generate Methods showsPrec :: Int -> GetInstallationHttpError -> ShowS # show :: GetInstallationHttpError -> String # showList :: [GetInstallationHttpError] -> ShowS #

data GetInstallationJsonDecodeError Source #

Constructors

GetInstallationJsonDecodeError
Fields body :: ByteString message :: String

Instances

Instances details

Exception GetInstallationJsonDecodeError Source #
Instance details Defined in GitHub.App.Token.Generate Methods toException :: GetInstallationJsonDecodeError -> SomeException # fromException :: SomeException -> Maybe GetInstallationJsonDecodeError # displayException :: GetInstallationJsonDecodeError -> String #
Show GetInstallationJsonDecodeError Source #
Instance details Defined in GitHub.App.Token.Generate Methods showsPrec :: Int -> GetInstallationJsonDecodeError -> ShowS # show :: GetInstallationJsonDecodeError -> String # showList :: [GetInstallationJsonDecodeError] -> ShowS #

Documentation

Instances

Instances

Finding installations by owner

Scoping AccessTokens

Instances

Errors

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Scoping `AccessToken`s