<back to all web services
ClientsAddReq
Remote Management
The following routes are available for this service:POST | /keycloak/clients/add | add a client to keycloak | |
---|
ClientsAddReq Parameters:Name | Parameter | Data Type | Required | Description |
---|
SessionId | query | string | Yes | The id of the REST session |
ClientId | form | string | No | The id of the client |
Name | form | string | No | The name of the client |
AdminUrl | form | string | No | The adminUrl of the client |
Protocol | form | string | No | The client protocol i.e. open-connect |
Description | form | string | No | The description of the client |
RootUrl | form | string | No | The rootUrl of the client |
BaseUrl | form | string | No | The baseUrl of the client |
ClientAuthenticatorType | form | string | No | i.e. client-secret etc... |
RedirectUris | form | List<string> | No | Redirect URLs |
Enabled | form | boolean | No | Is the client enabled |
RequestBase Parameters:Name | Parameter | Data Type | Required | Description |
---|
SessionId | form | string | No | |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
HTTP + XML
The following are sample HTTP requests and responses.
The placeholders shown need to be replaced with actual values.
POST /keycloak/clients/add HTTP/1.1
Host: n3tapi.palmettovdc.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ClientsAddReq xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Keycloak.Request.Clients">
<SessionId xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services.Keycloak.Request">String</SessionId>
<AdminUrl>String</AdminUrl>
<BaseUrl>String</BaseUrl>
<ClientAuthenticatorType>String</ClientAuthenticatorType>
<ClientId>String</ClientId>
<Description>String</Description>
<Enabled>false</Enabled>
<Name>String</Name>
<Protocol>String</Protocol>
<RedirectUris xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</RedirectUris>
<RootUrl>String</RootUrl>
</ClientsAddReq>