Arsharth/dex
1
0
Fork 0
forked from mystiq/dex
Code Issues Pull requests Projects Releases Packages Wiki Activity
dex/schema/adminschema
History
Bobby Rullo 399b15abeb integration, *: Improve tests for admin api 
* TestCreateClient was missing test coverage on error cases
* Fixed bug where 500s were being reported for bad requests
* changed function signature of NewAdminAPI back to old way of passing
  in lots of repos: passing in a DbMap made it difficult to test
* added swappable ID and Secret generators when creating Clients
2016-04-20 14:31:27 -07:00
..
mapper.go integration, *: Improve tests for admin api 2016-04-20 14:31:27 -07:00
mapper_test.go schema: tweaks to make Client API more regular 2016-04-15 17:22:59 -07:00
README.md schema: generate code 2016-04-15 17:23:27 -07:00
util.go *: move original project to dex 2015-08-18 11:26:57 -07:00
v1-gen.go schema: generate code 2016-04-15 17:23:27 -07:00
v1-json.go *: ClientIdentityXXX -> ClientXXX 2016-04-20 14:31:27 -07:00
v1.json schema: tweaks to make Client API more regular 2016-04-15 17:22:59 -07:00

README.md

Dex Admin API

The Dex Admin API.

Version: v1

Models

Admin

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

Client

{
    clientName: string // OPTIONAL. Name of the Client to be presented to the End-User. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) .,
    clientURI: string // OPTIONAL. URL of the home page of the Client. The value of this field MUST point to a valid Web page. If present, the server SHOULD display this URL to the End-User in a followable fashion. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) .,
    id: string // The client ID. Ignored in client create requests.,
    isAdmin: boolean,
    logoURI: string // OPTIONAL. URL that references a logo for the Client application. If present, the server SHOULD display this image to the End-User during approval. The value of this field MUST point to a valid image file. If desired, representation of this Claim in different languages and scripts is represented as described in Section 2.1 ( Metadata Languages and Scripts ) .,
    redirectURIs: [
        string
    ],
    secret: string
}

ClientCreateRequest

A request to register a client with dex.

{
    client: Client
}

ClientCreateResponse

Upon successful registration, an ID and secret is assigned to the client.

{
    client: Client
}

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

POST /client

Summary

Create Client

Description

Register an OpenID Connect client.

Parameters

Name Located in Description Required Type
body Yes ClientCreateRequest

Responses

Code Description Type
200 ClientCreateResponse
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