secret: string // The client secret. Ignored in client create requests.
}
```
@ -58,6 +58,38 @@ Upon successful registration, an ID and secret is assigned to the client.
}
```
### Connector
An object which describes a federating identity strategy. For documentation see Documentation/connectors-configuration.md. Since different connectors expect different object fields the scheme is omitted here.
```
```
### ConnectorsGetResponse
A list of all connector responses.
```
{
connectors: [
Connector
]
}
```
### ConnectorsSetRequest
A request to set all the connectors in the dex database.
```
{
connectors: [
Connector
]
}
```
### State
@ -150,6 +182,50 @@ Upon successful registration, an ID and secret is assigned to the client.
| default | Unexpected error | |
### GET /connectors
> __Summary__
> Get Connectors
> __Description__
> Return a list of the connectors for the dex system.
// "description": "Set the list of connectors for the dex system, overwriting all previous connectors. A 200 status code indicates the action was successful.",
// This file is automatically generated by schema/generator
//
@ -28,70 +27,66 @@ const DiscoveryJSON = `{
"parameters":{},
"auth":{},
"schemas":{
"Admin":{
"id":"Admin",
"type":"object",
"properties":{
"id":{
"type":"string"
},
"email":{
"type":"string"
},
"password":{
"type":"string"
}
}
},
"State":{
"id":"State",
"type":"object",
"properties":{
"AdminUserCreated":{
"type":"boolean"
}
}
},
"Client":{
"id":"Client",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The client ID. Ignored in client create requests."
},
"secret":{
"type":"string",
"description":"The client secret. Ignored in client create requests."
},
"secret":{
"type":"string",
"format":"byte"
},
"isAdmin":{
"type":"boolean"
},
"redirectURIs":{
"type":"array",
"items":{
"type":"string"
},
"description":"REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)."
},
"clientName":{
"type":"string",
"description":"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 ) ."
},
"logoURI":{
"type":"string",
"description":"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 ) ."
"Admin":{
"id":"Admin",
"type":"object",
"properties":{
"id":{
"type":"string"
},
"email":{
"type":"string"
},
"password":{
"type":"string"
}
}
},
"State":{
"id":"State",
"type":"object",
"properties":{
"AdminUserCreated":{
"type":"boolean"
}
}
},
"Client":{
"id":"Client",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The client ID. Ignored in client create requests."
},
"secret":{
"type":"string",
"description":"The client secret. Ignored in client create requests."
},
"isAdmin":{
"type":"boolean"
},
"redirectURIs":{
"type":"array",
"items":{
"type":"string"
},
"clientURI":{
"type":"string",
"description":"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 ) ."
}
"description":"REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)."
},
"clientName":{
"type":"string",
"description":"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 ) ."
},
"logoURI":{
"type":"string",
"description":"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 ) ."
},
"clientURI":{
"type":"string",
"description":"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 ) ."
}
},
}
},
"ClientCreateRequest":{
"id":"ClientCreateRequest",
"type":"object",
@ -107,78 +102,130 @@ const DiscoveryJSON = `{
"type":"object",
"description":"Upon successful registration, an ID and secret is assigned to the client.",
"properties":{
"client":{
"client":{
"$ref":"Client"
}
}
},
"Connector":{
"id":"Connector",
"type":"any",
"description":"An object which describes a federating identity strategy. For documentation see Documentation/connectors-configuration.md. Since different connectors expect different object fields the scheme is omitted here."
},
"ConnectorsSetRequest":{
"id":"ConnectorsSetRequest",
"type":"object",
"description":"A request to set all the connectors in the dex database.",
"properties":{
"connectors":{
"type":"array",
"items":{
"$ref":"Connector"
}
}
}
},
"ConnectorsGetResponse":{
"id":"ConnectorsGetResponse",
"type":"object",
"description":"A list of all connector responses.",
"properties":{
"connectors":{
"type":"array",
"items":{
"$ref":"Connector"
}
}
}
}
},
"resources":{
"Admin":{
"methods":{
"Get":{
"id":"dex.admin.Admin.Get",
"description":"Retrieve information about an admin user.",
"httpMethod":"GET",
"path":"admin/{id}",
"parameters":{
"id":{
"type":"string",
"required":true,
"location":"path"
}
},
"parameterOrder":[
"id"
],
"response":{
"$ref":"Admin"
}
},
"Create":{
"id":"dex.admin.Admin.Create",
"description":"Create a new admin user.",
"httpMethod":"POST",
"path":"admin",
"request":{
"$ref":"Admin"
},
"response":{
"$ref":"Admin"
}
}
"Admin":{
"methods":{
"Get":{
"id":"dex.admin.Admin.Get",
"description":"Retrieve information about an admin user.",
"httpMethod":"GET",
"path":"admin/{id}",
"parameters":{
"id":{
"type":"string",
"required":true,
"location":"path"
}
},
"parameterOrder":[
"id"
],
"response":{
"$ref":"Admin"
}
},
"State":{
"methods":{
"Get":{
"id":"dex.admin.State.Get",
"description":"Get the state of the Dex DB",
"httpMethod":"GET",
"path":"state",
"response":{
"$ref":"State"
}
}
},
"Create":{
"id":"dex.admin.Admin.Create",
"description":"Create a new admin user.",
"httpMethod":"POST",
"path":"admin",
"request":{
"$ref":"Admin"
},
"response":{
"$ref":"Admin"
}
},
"Client":{
"methods":{
"Create":{
"id":"dex.admin.Client.Create",
"description":"Register an OpenID Connect client.",
"httpMethod":"POST",
"path":"client",
"request":{
"$ref":"ClientCreateRequest"
},
"response":{
"$ref":"ClientCreateResponse"
}
}
}
}
},
"State":{
"methods":{
"Get":{
"id":"dex.admin.State.Get",
"description":"Get the state of the Dex DB",
"httpMethod":"GET",
"path":"state",
"response":{
"$ref":"State"
}
}
}
},
"Client":{
"methods":{
"Create":{
"id":"dex.admin.Client.Create",
"description":"Register an OpenID Connect client.",
"httpMethod":"POST",
"path":"client",
"request":{
"$ref":"ClientCreateRequest"
},
"response":{
"$ref":"ClientCreateResponse"
}
}
}
},
"Connectors":{
"methods":{
"Set":{
"id":"dex.admin.Connector.Set",
"description":"Set the list of connectors for the dex system, overwriting all previous connectors. A 200 status code indicates the action was successful.",
"httpMethod":"PUT",
"path":"connectors",
"request":{
"$ref":"ConnectorsSetRequest"
}
},
"Get":{
"id":"dex.admin.Connector.Get",
"description":"Return a list of the connectors for the dex system.",
"description":"The client ID. Ignored in client create requests."
},
"secret":{
"type":"string",
"description":"The client secret. Ignored in client create requests."
},
"isAdmin":{
"type":"boolean"
},
"redirectURIs":{
"type":"array",
"items":{
"type":"string"
},
"description":"REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)."
},
"clientName":{
"type":"string",
"description":"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 ) ."
},
"logoURI":{
"type":"string",
"description":"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 ) ."
"Admin":{
"id":"Admin",
"type":"object",
"properties":{
"id":{
"type":"string"
},
"email":{
"type":"string"
},
"password":{
"type":"string"
}
}
},
"State":{
"id":"State",
"type":"object",
"properties":{
"AdminUserCreated":{
"type":"boolean"
}
}
},
"Client":{
"id":"Client",
"type":"object",
"properties":{
"id":{
"type":"string",
"description":"The client ID. Ignored in client create requests."
},
"secret":{
"type":"string",
"description":"The client secret. Ignored in client create requests."
},
"isAdmin":{
"type":"boolean"
},
"redirectURIs":{
"type":"array",
"items":{
"type":"string"
},
"clientURI":{
"type":"string",
"description":"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 ) ."
}
"description":"REQUIRED. Array of Redirection URI values used by the Client. One of these registered Redirection URI values MUST exactly match the redirect_uri parameter value used in each Authorization Request, with the matching performed as described in Section 6.2.1 of [RFC3986] ( Berners-Lee, T., Fielding, R., and L. Masinter, “Uniform Resource Identifier (URI): Generic Syntax,” January 2005. ) (Simple String Comparison)."
},
"clientName":{
"type":"string",
"description":"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 ) ."
},
"logoURI":{
"type":"string",
"description":"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 ) ."
},
"clientURI":{
"type":"string",
"description":"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 ) ."
}
},
}
},
"ClientCreateRequest":{
"id":"ClientCreateRequest",
"type":"object",
@ -96,77 +96,129 @@
"type":"object",
"description":"Upon successful registration, an ID and secret is assigned to the client.",
"properties":{
"client":{
"client":{
"$ref":"Client"
}
}
},
"Connector":{
"id":"Connector",
"type":"any",
"description":"An object which describes a federating identity strategy. For documentation see Documentation/connectors-configuration.md. Since different connectors expect different object fields the scheme is omitted here."
},
"ConnectorsSetRequest":{
"id":"ConnectorsSetRequest",
"type":"object",
"description":"A request to set all the connectors in the dex database.",
"properties":{
"connectors":{
"type":"array",
"items":{
"$ref":"Connector"
}
}
}
},
"ConnectorsGetResponse":{
"id":"ConnectorsGetResponse",
"type":"object",
"description":"A list of all connector responses.",
"properties":{
"connectors":{
"type":"array",
"items":{
"$ref":"Connector"
}
}
}
}
},
"resources":{
"Admin":{
"methods":{
"Get":{
"id":"dex.admin.Admin.Get",
"description":"Retrieve information about an admin user.",
"httpMethod":"GET",
"path":"admin/{id}",
"parameters":{
"id":{
"type":"string",
"required":true,
"location":"path"
}
},
"parameterOrder":[
"id"
],
"response":{
"$ref":"Admin"
}
},
"Create":{
"id":"dex.admin.Admin.Create",
"description":"Create a new admin user.",
"httpMethod":"POST",
"path":"admin",
"request":{
"$ref":"Admin"
},
"response":{
"$ref":"Admin"
}
}
"Admin":{
"methods":{
"Get":{
"id":"dex.admin.Admin.Get",
"description":"Retrieve information about an admin user.",
"httpMethod":"GET",
"path":"admin/{id}",
"parameters":{
"id":{
"type":"string",
"required":true,
"location":"path"
}
},
"parameterOrder":[
"id"
],
"response":{
"$ref":"Admin"
}
},
"Create":{
"id":"dex.admin.Admin.Create",
"description":"Create a new admin user.",
"httpMethod":"POST",
"path":"admin",
"request":{
"$ref":"Admin"
},
"response":{
"$ref":"Admin"
}
}
}
},
"State":{
"methods":{
"Get":{
"id":"dex.admin.State.Get",
"description":"Get the state of the Dex DB",
"httpMethod":"GET",
"path":"state",
"response":{
"$ref":"State"
}
},
"State":{
"methods":{
"Get":{
"id":"dex.admin.State.Get",
"description":"Get the state of the Dex DB",
"httpMethod":"GET",
"path":"state",
"response":{
"$ref":"State"
}
}
}
}
},
"Client":{
"methods":{
"Create":{
"id":"dex.admin.Client.Create",
"description":"Register an OpenID Connect client.",
"httpMethod":"POST",
"path":"client",
"request":{
"$ref":"ClientCreateRequest"
},
"response":{
"$ref":"ClientCreateResponse"
}
},
"Client":{
"methods":{
"Create":{
"id":"dex.admin.Client.Create",
"description":"Register an OpenID Connect client.",
"httpMethod":"POST",
"path":"client",
"request":{
"$ref":"ClientCreateRequest"
},
"response":{
"$ref":"ClientCreateResponse"
}
}
}
}
},
"Connectors":{
"methods":{
"Set":{
"id":"dex.admin.Connector.Set",
"description":"Set the list of connectors for the dex system, overwriting all previous connectors. A 200 status code indicates the action was successful.",
"httpMethod":"PUT",
"path":"connectors",
"request":{
"$ref":"ConnectorsSetRequest"
}
},
"Get":{
"id":"dex.admin.Connector.Get",
"description":"Return a list of the connectors for the dex system.",