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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"sessionId":"String","clientId":"String","name":"String","adminUrl":"String","protocol":"String","description":"String","rootUrl":"String","baseUrl":"String","clientAuthenticatorType":"String","redirectUris":["String"],"enabled":false}