Categorygithub.com/advoretsky/atlassian-api/orgs
modulepackage
0.1.1
Repository: https://github.com/advoretsky/atlassian-api.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
23
Dependents
0
Files
737 SLOC

# README

Go API client for orgs

Atlassian Administration API

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.0.0
  • Package version: 0.1.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional

Put the package under your project folder and add the following in import:

import "./orgs"

Documentation for API Endpoints

All URIs are relative to https://api.atlassian.com/admin/v1/orgs

ClassMethodHTTP requestDescription
DefaultApiOrgIdUsersGetGet /{orgId}/users

Documentation For Models

Documentation For Authorization

basicAuth

  • Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

Author

# Functions

CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.

# Variables

ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.

# Structs

APIClient manages communication with the Atlassian Administration API API v1.0.0 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
Links struct for Links.
LinksAllOf struct for LinksAllOf.
OrgIdUsersGetOpts Optional parameters for the method 'OrgIdUsersGet'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
User struct for User.
UserAllOf struct for UserAllOf.
UserPageResponse struct for UserPageResponse.

# Type aliases

DefaultApiService DefaultApi service.