README

Dex API

The Dex REST API

Version: v1

Models

Error
{
    error: string,
    error_description: string
}
RefreshClient

A client with associated public metadata.

{
    clientID: string,
    clientName: string,
    clientURI: string,
    logoURI: string
}
RefreshClientList
{
    clients: [
        RefreshClient
    ]
}
ResendEmailInvitationRequest
{
    redirectURL: string
}
ResendEmailInvitationResponse
{
    emailSent: boolean,
    resetPasswordLink: string
}
User
{
    admin: boolean,
    createdAt: string,
    disabled: boolean,
    displayName: string,
    email: string,
    emailVerified: boolean,
    id: string
}
UserCreateRequest
{
    redirectURL: string,
    user: User
}
UserCreateResponse
{
    emailSent: boolean,
    resetPasswordLink: string,
    user: User
}
UserDisableRequest
{
    disable: boolean // If true, disable this user, if false, enable them. No error is signaled if the user state doesn't change.
}
UserDisableResponse
{
    ok: boolean
}
UserResponse
{
    user: User
}
UsersResponse
{
    nextPageToken: string,
    users: [
        User
    ]
}

Paths

GET /account/{userid}/refresh

Summary

List RefreshClient

Description

List all clients that hold refresh tokens for the specified user.

Parameters

Name Located in Description Required Type
userid path Yes string

Responses

Code Description Type
200 RefreshClientList
default Unexpected error
DELETE /account/{userid}/refresh/{clientid}

Summary

Revoke RefreshClient

Description

Revoke all refresh tokens issues to the client for the specified user.

Parameters

Name Located in Description Required Type
userid path Yes string
clientid path Yes string

Responses

Code Description Type
default Unexpected error
GET /users

Summary

List Users

Description

Retrieve a page of User objects.

Parameters

Name Located in Description Required Type
nextPageToken query No string
maxResults query No integer

Responses

Code Description Type
200 UsersResponse
default Unexpected error
POST /users

Summary

Create Users

Description

Create a new User.

Parameters

Name Located in Description Required Type
body Yes UserCreateRequest

Responses

Code Description Type
200 UserCreateResponse
default Unexpected error
GET /users/{id}

Summary

Get Users

Description

Get a single User object by id.

Parameters

Name Located in Description Required Type
id path Yes string

Responses

Code Description Type
200 UserResponse
default Unexpected error
POST /users/{id}/disable

Summary

Disable Users

Description

Enable or disable a user.

Parameters

Name Located in Description Required Type
id path Yes string
body Yes UserDisableRequest

Responses

Code Description Type
200 UserDisableResponse
default Unexpected error
POST /users/{id}/resend-invitation

Summary

ResendEmailInvitation Users

Description

Resend invitation email to an existing user with unverified email.

Parameters

Name Located in Description Required Type
id path Yes string
body Yes ResendEmailInvitationRequest

Responses

Code Description Type
200 ResendEmailInvitationResponse
default Unexpected error
Expand ▾ Collapse ▴

Documentation

Overview

    Package workerschema provides access to the Dex API.

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

    Usage example: 

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

    Index

    Constants

    View Source 
    const DiscoveryJSON = `` /* 7917-byte string literal not displayed */

      This file is automatically generated by schema/generator

      **** DO NOT EDIT ****

      Variables

      This section is empty.

      Functions

      This section is empty.

      Types

      type Error 

      type Error struct {
	Error string `json:"error,omitempty"`

	Error_description string `json:"error_description,omitempty"`
}

      type RefreshClient 

      type RefreshClient struct {
	ClientID string `json:"clientID,omitempty"`

	ClientName string `json:"clientName,omitempty"`

	ClientURI string `json:"clientURI,omitempty"`

	LogoURI string `json:"logoURI,omitempty"`
}

      type RefreshClientList 

      type RefreshClientList struct {
	Clients []*RefreshClient `json:"clients,omitempty"`
}

      type RefreshClientListCall 

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

      func (*RefreshClientListCall) Do 

      func (c *RefreshClientListCall) Do() (*RefreshClientList, error)

      func (*RefreshClientListCall) Fields 

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

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

        type RefreshClientRevokeCall 

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

        func (*RefreshClientRevokeCall) Do 

        func (c *RefreshClientRevokeCall) Do() error

        func (*RefreshClientRevokeCall) Fields 

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

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

          type RefreshClientService 

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

          func NewRefreshClientService 

          func NewRefreshClientService(s *Service) *RefreshClientService

          func (*RefreshClientService) List 

          func (r *RefreshClientService) List(userid string) *RefreshClientListCall

            List: List all clients that hold refresh tokens for the specified user.

            func (*RefreshClientService) Revoke 

            func (r *RefreshClientService) Revoke(userid string, clientid string) *RefreshClientRevokeCall

              Revoke: Revoke all refresh tokens issues to the client for the specified user.

              type ResendEmailInvitationRequest 

              type ResendEmailInvitationRequest struct {
	RedirectURL string `json:"redirectURL,omitempty"`
}

              type ResendEmailInvitationResponse 

              type ResendEmailInvitationResponse struct {
	EmailSent bool `json:"emailSent,omitempty"`

	ResetPasswordLink string `json:"resetPasswordLink,omitempty"`
}

              type Service 

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

	RefreshClient *RefreshClientService

	Users *UsersService
	// 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 User 

              type User struct {
	Admin bool `json:"admin,omitempty"`

	CreatedAt string `json:"createdAt,omitempty"`

	Disabled bool `json:"disabled,omitempty"`

	DisplayName string `json:"displayName,omitempty"`

	Email string `json:"email,omitempty"`

	EmailVerified bool `json:"emailVerified,omitempty"`

	Id string `json:"id,omitempty"`
}

              type UserCreateRequest 

              type UserCreateRequest struct {
	RedirectURL string `json:"redirectURL,omitempty"`

	User *User `json:"user,omitempty"`
}

              type UserCreateResponse 

              type UserCreateResponse struct {
	EmailSent bool `json:"emailSent,omitempty"`

	ResetPasswordLink string `json:"resetPasswordLink,omitempty"`

	User *User `json:"user,omitempty"`
}

              type UserCreateResponseUser 

              type UserCreateResponseUser struct {
}

              type UserDisableRequest 

              type UserDisableRequest struct {
	// Disable: If true, disable this user, if false, enable them. No error
	// is signaled if the user state doesn't change.
	Disable bool `json:"disable,omitempty"`
}

              type UserDisableResponse 

              type UserDisableResponse struct {
	Ok bool `json:"ok,omitempty"`
}

              type UserResponse 

              type UserResponse struct {
	User *User `json:"user,omitempty"`
}

              type UsersCreateCall 

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

              func (*UsersCreateCall) Do 

              func (c *UsersCreateCall) Do() (*UserCreateResponse, error)

              func (*UsersCreateCall) Fields 

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

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

                type UsersDisableCall 

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

                func (*UsersDisableCall) Do 

                func (c *UsersDisableCall) Do() (*UserDisableResponse, error)

                func (*UsersDisableCall) Fields 

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

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

                  type UsersGetCall 

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

                  func (*UsersGetCall) Do 

                  func (c *UsersGetCall) Do() (*UserResponse, error)

                  func (*UsersGetCall) Fields 

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

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

                    type UsersListCall 

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

                    func (*UsersListCall) Do 

                    func (c *UsersListCall) Do() (*UsersResponse, error)

                    func (*UsersListCall) Fields 

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

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

                      func (*UsersListCall) MaxResults 

                      func (c *UsersListCall) MaxResults(maxResults int64) *UsersListCall

                        MaxResults sets the optional parameter "maxResults":

                        func (*UsersListCall) NextPageToken 

                        func (c *UsersListCall) NextPageToken(nextPageToken string) *UsersListCall

                          NextPageToken sets the optional parameter "nextPageToken":

                          type UsersResendEmailInvitationCall 

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

                          func (*UsersResendEmailInvitationCall) Do 

                          func (c *UsersResendEmailInvitationCall) Do() (*ResendEmailInvitationResponse, error)

                          func (*UsersResendEmailInvitationCall) Fields 

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

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

                            type UsersResponse 

                            type UsersResponse struct {
	NextPageToken string `json:"nextPageToken,omitempty"`

	Users []*User `json:"users,omitempty"`
}

                            type UsersService 

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

                            func NewUsersService 

                            func NewUsersService(s *Service) *UsersService

                            func (*UsersService) Create 

                            func (r *UsersService) Create(usercreaterequest *UserCreateRequest) *UsersCreateCall

                              Create: Create a new User.

                              func (*UsersService) Disable 

                              func (r *UsersService) Disable(id string, userdisablerequest *UserDisableRequest) *UsersDisableCall

                                Disable: Enable or disable a user.

                                func (*UsersService) Get 

                                func (r *UsersService) Get(id string) *UsersGetCall

                                  Get: Get a single User object by id.

                                  func (*UsersService) List 

                                  func (r *UsersService) List() *UsersListCall

                                    List: Retrieve a page of User objects.

                                    func (*UsersService) ResendEmailInvitation 

                                    func (r *UsersService) ResendEmailInvitation(id string, resendemailinvitationrequest *ResendEmailInvitationRequest) *UsersResendEmailInvitationCall

                                      ResendEmailInvitation: Resend invitation email to an existing user with unverified email.

                                      Source Files

                                      View all