Register tenant
This operation registers tenant information. This API can handle only single tenant registration at a time.
Method: HTTP POST
Endpoint: http://<host_address>:<port_address>/v1/tenant
Parameter | Cardinality | Description |
---|---|---|
X-API-AppId | Mandatory | The application ID is used for getting the user details. |
X-API-Key | Mandatory | This key is used for getting the user details. |
Note: Note that the identityProviderType value is case-sensitive.
The following sample is shown for RelationalSchema (Postgres/Oracle) identityProviderType:
{ "tenantId": "TIBCO", "clientId": "order", "clientSecret": "order", "identityProviderType": "POSTGRES", "supportAlgorithm": "HS256", "signingKey": "100f4c1f-f333-4c25-bd8c-e4809722b6a7", "relationalSchema": { "dataSourceURL": "jdbc:postgresql://localhost:5432/userdbll?currentSchema=userschemall", "dataSourceUserName": "userll", "dataSourcePassword": "userll" } }
The following sample is shown for LDAP identityProviderType:
{ "tenantId": "TIBCOLDAP", "clientId": "tibco-ldap-client", "clientSecret": "tibco-ldap-secret", "identityProviderType": "LDAP", "supportAlgorithm": "HS256", "signingKey": "100f4c1f-f333-4c25-bd8c-e4809722b6a7", "ldapSchema": { "ldapURLForDirectoryService": "string", "directoryServiceDomainName": "string", "directoryServiceRootDistinguishedName": "string" } }
The following sample is shown for EXTERNAL identityProviderType:
Note: In case of RS256 supportAlgorithm, jwkSetUrl and issuer are required.
They are not needed in case of HS256.
{ "tenantId": "string", "clientId": "string", "clientSecret": "string", "identityProviderType": "EXTERNAL", "signingKey": "100f4c1f-f333-4c25-bd8c-e4809722b6a7", "supportAlgorithm": "RS256", "jwkSetUrl": "string", "issuer": "string", "oidcSchema": { "authUrl": "string", "accessTokenUrl": "string", "scope": "string" } }