Net3 API Interface for Customer Portal

<back to all web services

ClientsAddReq

Remote Management

Requires Authentication
The following routes are available for this service:
POST/keycloak/clients/addadd a client to keycloak
ClientsAddReq Parameters:
NameParameterData TypeRequiredDescription
SessionIdquerystringYesThe id of the REST session
ClientIdformstringNoThe id of the client
NameformstringNoThe name of the client
AdminUrlformstringNoThe adminUrl of the client
ProtocolformstringNoThe client protocol i.e. open-connect
DescriptionformstringNoThe description of the client
RootUrlformstringNoThe rootUrl of the client
BaseUrlformstringNoThe baseUrl of the client
ClientAuthenticatorTypeformstringNoi.e. client-secret etc...
RedirectUrisformList<string>NoRedirect URLs
EnabledformbooleanNoIs the client enabled
RequestBase Parameters:
NameParameterData TypeRequiredDescription
SessionIdformstringNo

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>