adminschema

README

Dex Admin API

The Dex Admin API.

Version: v1

Models

Admin

{
    email: string,
    id: string,
    password: string
}

State

{
    AdminUserCreated: boolean
}

Paths

POST /admin

Summary

Create Admin

Description

Create a new admin user.

Parameters

|Name|Located in|Description|Required|Type| |:-----|:-----|:-----|:-----|:-----| | | body | | Yes | Admin |

Responses

|Code|Description|Type| |:-----|:-----|:-----| | 200 | | Admin | | default | Unexpected error | |

GET /admin/{id}

Summary

Get Admin

Description

Retrieve information about an admin user.

Parameters

|Name|Located in|Description|Required|Type| |:-----|:-----|:-----|:-----|:-----| | id | path | | Yes | string |

Responses

|Code|Description|Type| |:-----|:-----|:-----| | 200 | | Admin | | default | Unexpected error | |

GET /state

Summary

Get State

Description

Get the state of the Dex DB

Responses

|Code|Description|Type| |:-----|:-----|:-----| | 200 | | State | | default | Unexpected error | |

Documentation

Overview

Package adminschema provides access to the Dex Admin API.

See http://github.com/coreos/dex

Usage example:

import "google.golang.org/api/adminschema/v1"
...
adminschemaService, err := adminschema.New(oauthHttpClient)

Index

• Constants
• type Admin
• type AdminCreateCall
  • func (c *AdminCreateCall) Do() (*Admin, error)
  • func (c *AdminCreateCall) Fields(s ...googleapi.Field) *AdminCreateCall
• type AdminGetCall
  • func (c *AdminGetCall) Do() (*Admin, error)
  • func (c *AdminGetCall) Fields(s ...googleapi.Field) *AdminGetCall
• type AdminService
  • func NewAdminService(s *Service) *AdminService
  • func (r *AdminService) Create(admin *Admin) *AdminCreateCall
  • func (r *AdminService) Get(id string) *AdminGetCall
• type Service
  • func New(client *http.Client) (*Service, error)
  • func NewWithBasePath(client *http.Client, basePath string) (*Service, error)
• type State
• type StateGetCall
  • func (c *StateGetCall) Do() (*State, error)
  • func (c *StateGetCall) Fields(s ...googleapi.Field) *StateGetCall
• type StateService
  • func NewStateService(s *Service) *StateService
  • func (r *StateService) Get() *StateGetCall

Constants

const DiscoveryJSON = `` /* 2629-byte string literal not displayed */

This file is automatically generated by schema/generator

**** DO NOT EDIT ****

Types

type Admin

type Admin struct {
	Email string `json:"email,omitempty"`

	Id string `json:"id,omitempty"`

	Password string `json:"password,omitempty"`
}

type AdminCreateCall

type AdminCreateCall struct {
	// contains filtered or unexported fields
}

func (*AdminCreateCall) Do

func (c *AdminCreateCall) Do() (*Admin, error)

func (*AdminCreateCall) Fields

func (c *AdminCreateCall) Fields(s ...googleapi.Field) *AdminCreateCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AdminGetCall

type AdminGetCall struct {
	// contains filtered or unexported fields
}

func (*AdminGetCall) Do

func (c *AdminGetCall) Do() (*Admin, error)

func (*AdminGetCall) Fields

func (c *AdminGetCall) Fields(s ...googleapi.Field) *AdminGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type AdminService

type AdminService struct {
	// contains filtered or unexported fields
}

func NewAdminService

func NewAdminService(s *Service) *AdminService

func (*AdminService) Create

func (r *AdminService) Create(admin *Admin) *AdminCreateCall

Create: Create a new admin user.

func (*AdminService) Get

func (r *AdminService) Get(id string) *AdminGetCall

Get: Retrieve information about an admin user.

type Service

type Service struct {
	BasePath string // API endpoint base URL

	Admin *AdminService

	State *StateService
	// contains filtered or unexported fields
}

func New

func New(client *http.Client) (*Service, error)

func NewWithBasePath

func NewWithBasePath(client *http.Client, basePath string) (*Service, error)

type State

type State struct {
	AdminUserCreated bool `json:"AdminUserCreated,omitempty"`
}

type StateGetCall

type StateGetCall struct {
	// contains filtered or unexported fields
}

func (*StateGetCall) Do

func (c *StateGetCall) Do() (*State, error)

func (*StateGetCall) Fields

func (c *StateGetCall) Fields(s ...googleapi.Field) *StateGetCall

Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more information.

type StateService

type StateService struct {
	// contains filtered or unexported fields
}

func NewStateService

func NewStateService(s *Service) *StateService

func (*StateService) Get

func (r *StateService) Get() *StateGetCall

Get: Get the state of the Dex DB