package gitlab-jsoo

You can search for identifiers within the package.

in-package search v0.2.0

package gitlab-jsoo

gitlab-jsoo
- Gitlab
  - API
  - Endpoint
    
    Version
  - Event
  - Group
    
    Issue
    
    Milestone
    
    Project
  - Monad
  - Project
    
    Branch
    
    Commit
    
    ExternalStatusCheck
    
    Hook
    
    Issue
    
    Milestone
    
    Notes
    
    Merge_request
    
    ProjectAccessToken
  - Response
  - Runners
  - Scope
  - Stream
  - Token
  - User
    
    PersonalAccessToken

Legend:
Library
Module
Module type
Parameter
Class
Class type

Authentication Token for accessing GitLab APIs.

Of the several ways provided in GitLab, we currently support:

Personal Access Tokens
Project Access Tokens
OAuth Authorization Codes

type oauth = {

access_token : string;
refresh_token : string;

}

type t =

| AccessToken of string
| OAuthToken of oauth
(*
t is the abstract type of a token.
*)

type grant_type =

| AuthorizationCode
| RefreshToken

val create_url : 
  client_id:string ->
  redirect_uri:Uri.t ->
  state:string ->
  scopes:Gitlab_t.scope list ->
  unit ->
  Uri.t

Create URL for Authorisation code flow. https://docs.gitlab.com/ee/api/oauth2.html#authorization-code-flow

val of_code : 
  client_id:string ->
  client_secret:string ->
  ?grant_type:grant_type ->
  redirect_uri:string ->
  code:string ->
  unit ->
  t option Lwt.t

Retrieve an OAuth Token using the default grant_type AuthorizationCode. Use the refresh_token along with a grant_type of RefreshToken to request a refreshed OAuth Token.

val of_string : string -> t

of_string create an AccessToken.

val to_string : t -> string

to_string token is the string serialization of token.