org.kohsuke.github

Class GHAppCreateTokenBuilder

java.lang.Object

org.kohsuke.github.GHAppCreateTokenBuilder

public class GHAppCreateTokenBuilder
extends Object

Creates a access token for a GitHub App Installation

Author:

Paulo Miguel Almeida

See Also:

GHAppInstallation#createToken(Map), GHAppInstallation#createToken()

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kohsuke.github.Requester	builder

Method Summary

Modifier and Type	Method and Description
GHAppInstallationToken	create() Deprecated.
GHAppCreateTokenBuilder	permissions(Map<String,GHPermissionType> permissions) Deprecated.
GHAppCreateTokenBuilder	repositoryIds(List<Long> repositoryIds) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

builder

protected final org.kohsuke.github.Requester builder

Method Detail

repositoryIds

@Preview
 @Deprecated
public GHAppCreateTokenBuilder repositoryIds(List<Long> repositoryIds)

Deprecated.

By default the installation token has access to all repositories that the installation can access. To restrict the access to specific repositories, you can provide the repository_ids when creating the token. When you omit repository_ids, the response does not contain neither the repositories nor the permissions key.

Parameters:

repositoryIds - Array containing the repositories Ids

Returns:

a GHAppCreateTokenBuilder

permissions

@Preview
 @Deprecated
public GHAppCreateTokenBuilder permissions(Map<String,GHPermissionType> permissions)

Deprecated.

Set the permissions granted to the access token. The permissions object includes the permission names and their access type.

Parameters:

permissions - Map containing the permission names and types.

Returns:

a GHAppCreateTokenBuilder

create

@Preview
 @Deprecated
public GHAppInstallationToken create()
                                                    throws IOException

Deprecated.

Creates an app token with all the parameters.

You must use a JWT to access this endpoint.

Returns:

a GHAppInstallationToken

Throws:

IOException - on error