client_name: 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 ) .,
client_uri: 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 ) .,
logo_uri: 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 ) .,
redirect_uris: [
string
]
},
isAdmin: boolean
}
```
### ClientRegistrationResponse
Upon successful registration, an ID and secret is assigned to the client.
```
{
client_id: string,
client_secret: string
}
```
### State
@ -86,6 +115,32 @@ __Version:__ v1
| default | Unexpected error | |
### POST /client
> __Summary__
> Create Client
> __Description__
> Register an OpenID Connect client.
> __Parameters__
> |Name|Located in|Description|Required|Type|
|:-----|:-----|:-----|:-----|:-----|
| | body | | Yes | [ClientCreateRequest](#clientcreaterequest) |
"description":"A request to register a client with dex.",
"properties":{
"isAdmin":{
"type":"boolean"
},
"client":{
"type":"object",
"properties":{
"redirect_uris":{
"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)."
},
"client_name":{
"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 ) ."
},
"logo_uri":{
"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 ) ."
},
"client_uri":{
"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 ) ."
}
}
}
}
},
"ClientRegistrationResponse":{
"id":"ClientRegistrationResponse",
"type":"object",
"description":"Upon successful registration, an ID and secret is assigned to the client.",
"properties":{
"client_id":{
"type":"string"
},
"client_secret":{
"type":"string"
}
}
}
},
"resources":{
@ -101,6 +148,22 @@ const DiscoveryJSON = `{
}
}
}
},
"Client":{
"methods":{
"Create":{
"id":"dex.admin.Client.Create",
"description":"Register an OpenID Connect client.",