CODEWITHSUNDEEP
wso2wso2-identity-server
positron
positron

Reputation: 3693

Specifying custom tenant id in REST API

In SOAP Teanant API I can define my own tenantId (https://docs.wso2.com/display/IS530/Managing+Tenants+with+APIs#ManagingTenantswithAPIs-addTenant()), but in REST API this ability is not available. The reason I wanted to use custom tenantId is so that I can map multi-tenancy from WSO2 domain to my application domain, thus using id as a bridge. There is additonalClaims element in request JSON for addTenant endpoint, but this element is not returned in getTenant endpoint. Is there additional tenant property I can use to store custom information?

Upvotes: 0

Views: 1925

Answers (1)

Anuradha Karunarathna
Anuradha Karunarathna

Reputation: 3057

The Tenant creation REST API doesn't allow to input the tenant id. But you can use the returned tenant id for the mapping purpose. Once a tenant is created successfully using API, It should return 201 Cretaed status code and you would be able to find the Location header in the response headers. The location header contains the location to the tenant. https://<Host>:<port>/t/<tenant-domain>/api/server/v1/tenants/<tenant-id>. From this value you can extract the tenant id.

For the second part of the question: additonalClaims attribute belongs to tenant owners not to the core tenant object. When you execute GET /tenants or GET /tenants/ request, owner's id and username are returned.

 "owners": [
        {
            "id": "af01d6cf-bf5d-440f-b99c-ac482f6dc89f",
            "username": "kim"
        }
    ]

If you check the tenant owner's profile via carbon console/console you should see the additional claims added via the request. Moreover, if that added local claim is mapped to a SCIM claim (eg: http://wso2.org/claims/mobile) you would view that user properties via SCIM GET User API.

eg: https://<host>:<port>/t/<tenant-domain>/scim2/Users/<tenant-ownser's-id>

Upvotes: 1

Related Questions