Update a tenant
PUT
/api/tenant/{tenantId}/Tenants/{id}
using System.Net.Http.Headers;var client = new HttpClient();var request = new HttpRequestMessage{ Method = HttpMethod.Put, RequestUri = new Uri("https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"), Headers = { { "Authorization", "Bearer <token>" }, }, Content = new StringContent("{ \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"id\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"relations\": [ { \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"id\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"name\": \"example\", \"entityId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"entityType\": \"example\", \"relationType\": \"example\" } ], \"tenantId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"resourceGroupId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"creatorId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"createdDate\": \"2026-04-15T12:00:00Z\", \"version\": 1, \"lastModified\": \"2026-04-15T12:00:00Z\", \"name\": \"example\", \"description\": \"example\", \"email\": \"example\", \"logoId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"bannerId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"hostName\": \"example\", \"identityDomain\": \"example\", \"address\": { \"coAddress\": \"example\", \"state\": \"example\", \"country\": \"example\", \"name\": \"example\", \"firstName\": \"example\", \"lastName\": \"example\", \"street\": \"example\", \"postalCode\": \"example\", \"city\": \"example\" }, \"uniqueName\": \"example\", \"defaultClientId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"defaultResourceGroupId\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"domains\": [ { \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"id\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"value\": \"example\" } ], \"loginProviders\": [ { \"fields\": { \"additionalProperty\": { \"value\": \"example\", \"valueType\": \"example\" } }, \"accessibility\": \"example\", \"id\": \"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0\", \"name\": \"example\", \"clientId\": \"example\", \"clientSecret\": \"example\", \"token\": \"example\", \"hasClientSecret\": true, \"hasToken\": true, \"scopes\": [ \"example\" ], \"requestOfflineAccess\": true, \"authority\": \"example\", \"type\": \"example\", \"callbackPath\": \"example\" } ], \"languages\": [ \"example\" ], \"allowedOrigins\": [ \"example\" ] }") { Headers = { ContentType = new MediaTypeHeaderValue("application/json") } }};using (var response = await client.SendAsync(request)){ response.EnsureSuccessStatusCode(); var body = await response.Content.ReadAsStringAsync(); Console.WriteLine(body);}const url = 'https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","relations":[{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","entityId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","entityType":"example","relationType":"example"}],"tenantId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","resourceGroupId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","creatorId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","createdDate":"2026-04-15T12:00:00Z","version":1,"lastModified":"2026-04-15T12:00:00Z","name":"example","description":"example","email":"example","logoId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","bannerId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","hostName":"example","identityDomain":"example","address":{"coAddress":"example","state":"example","country":"example","name":"example","firstName":"example","lastName":"example","street":"example","postalCode":"example","city":"example"},"uniqueName":"example","defaultClientId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","defaultResourceGroupId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","domains":[{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","value":"example"}],"loginProviders":[{"fields":{"additionalProperty":{"value":"example","valueType":"example"}},"accessibility":"example","id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","name":"example","clientId":"example","clientSecret":"example","token":"example","hasClientSecret":true,"hasToken":true,"scopes":["example"],"requestOfflineAccess":true,"authority":"example","type":"example","callbackPath":"example"}],"languages":["example"],"allowedOrigins":["example"]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.nimles.com/identity/api/tenant/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/Tenants/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "relations": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entityType": "example", "relationType": "example" } ], "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "createdDate": "2026-04-15T12:00:00Z", "version": 1, "lastModified": "2026-04-15T12:00:00Z", "name": "example", "description": "example", "email": "example", "logoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bannerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hostName": "example", "identityDomain": "example", "address": { "coAddress": "example", "state": "example", "country": "example", "name": "example", "firstName": "example", "lastName": "example", "street": "example", "postalCode": "example", "city": "example" }, "uniqueName": "example", "defaultClientId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultResourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "domains": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example" } ], "loginProviders": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "clientId": "example", "clientSecret": "example", "token": "example", "hasClientSecret": true, "hasToken": true, "scopes": [ "example" ], "requestOfflineAccess": true, "authority": "example", "type": "example", "callbackPath": "example" } ], "languages": [ "example" ], "allowedOrigins": [ "example" ] }'Updates an existing tenant. Domains and login providers keep their accessibility, and a login provider without
authority, type or callbackPath keeps the current ones. Responses never carry a login
provider’s clientSecret or token; one sent back empty keeps the stored value, and a login provider
that changes its authority, clientId or type must send its clientSecret again (422
otherwise).
A tenant owner can update only the tenant the request is made in (403 otherwise), and only its owners’ settings:
the platform-owned ones (hostName, identityDomain, domains, loginProviders,
defaultClientId, allowedOrigins, uniqueName) keep their current values whatever the
request carries. A platform administrator can update any tenant and all its settings.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”id
required
string format: uuid
A unique identifier for the tenant.
tenantId
required
string format: uuid
Your tenant id.
Request Body
Section titled “Request Body”The tenant data.
Media typeapplication/json
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
relations
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
string
entityId
required
string format: uuid
entityType
required
string
relationType
required
string
tenantId
string format: uuid
resourceGroupId
string format: uuid
creatorId
string format: uuid
createdDate
string format: date-time
version
integer format: int32
lastModified
string format: date-time
name
required
string
description
string
email
string
logoId
string format: uuid
bannerId
string format: uuid
hostName
string
identityDomain
string
address
object
coAddress
string
state
string
country
string
name
string
firstName
string
lastName
string
street
string
postalCode
string
city
string
uniqueName
string
defaultClientId
string format: uuid
defaultResourceGroupId
string format: uuid
domains
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
value
required
string
loginProviders
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
required
string
clientId
required
string
clientSecret
required
string
token
required
string
hasClientSecret
boolean
hasToken
boolean
scopes
Array<string>
requestOfflineAccess
boolean
authority
string
type
string
callbackPath
string
languages
Array<string>
allowedOrigins
Array<string>
Example generated
{ "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "relations": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entityType": "example", "relationType": "example" } ], "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "createdDate": "2026-04-15T12:00:00Z", "version": 1, "lastModified": "2026-04-15T12:00:00Z", "name": "example", "description": "example", "email": "example", "logoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bannerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hostName": "example", "identityDomain": "example", "address": { "coAddress": "example", "state": "example", "country": "example", "name": "example", "firstName": "example", "lastName": "example", "street": "example", "postalCode": "example", "city": "example" }, "uniqueName": "example", "defaultClientId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultResourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "domains": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example" } ], "loginProviders": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "clientId": "example", "clientSecret": "example", "token": "example", "hasClientSecret": true, "hasToken": true, "scopes": [ "example" ], "requestOfflineAccess": true, "authority": "example", "type": "example", "callbackPath": "example" } ], "languages": [ "example" ], "allowedOrigins": [ "example" ]}Responses
Section titled “Responses”OK
Media typeapplication/json
object
fields
object
key
additional properties
string
data
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
relations
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
string
entityId
required
string format: uuid
entityType
required
string
relationType
required
string
tenantId
string format: uuid
resourceGroupId
string format: uuid
creatorId
string format: uuid
createdDate
string format: date-time
version
integer format: int32
lastModified
string format: date-time
name
required
string
description
string
email
string
logoId
string format: uuid
bannerId
string format: uuid
hostName
string
identityDomain
string
address
object
coAddress
string
state
string
country
string
name
string
firstName
string
lastName
string
street
string
postalCode
string
city
string
uniqueName
string
defaultClientId
string format: uuid
defaultResourceGroupId
string format: uuid
domains
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
value
required
string
loginProviders
Array<object>
object
fields
object
key
additional properties
object
value
required
valueType
string
accessibility
string
id
string format: uuid
name
required
string
clientId
required
string
clientSecret
required
string
token
required
string
hasClientSecret
boolean
hasToken
boolean
scopes
Array<string>
requestOfflineAccess
boolean
authority
string
type
string
callbackPath
string
languages
Array<string>
allowedOrigins
Array<string>
Example generated
{ "data": { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "relations": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "entityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "entityType": "example", "relationType": "example" } ], "tenantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "resourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "creatorId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "createdDate": "2026-04-15T12:00:00Z", "version": 1, "lastModified": "2026-04-15T12:00:00Z", "name": "example", "description": "example", "email": "example", "logoId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "bannerId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "hostName": "example", "identityDomain": "example", "address": { "coAddress": "example", "state": "example", "country": "example", "name": "example", "firstName": "example", "lastName": "example", "street": "example", "postalCode": "example", "city": "example" }, "uniqueName": "example", "defaultClientId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "defaultResourceGroupId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "domains": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "value": "example" } ], "loginProviders": [ { "fields": { "additionalProperty": { "value": "example", "valueType": "example" } }, "accessibility": "example", "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "clientId": "example", "clientSecret": "example", "token": "example", "hasClientSecret": true, "hasToken": true, "scopes": [ "example" ], "requestOfflineAccess": true, "authority": "example", "type": "example", "callbackPath": "example" } ], "languages": [ "example" ], "allowedOrigins": [ "example" ] }}No Content: done, with no item to return.
Unauthorized: no bearer token, or one that is expired or not for this API.
Forbidden: the caller holds no role that allows this action at this scope. The body is empty, or a problem whose detail names the action.
Media typeapplication/json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Not found: no such item in the tenant.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Conflict: the item kept changing under concurrent writes; read it again and retry.
Media typeapplication/problem+json
An RFC 9457 problem.
object
detail
string
instance
string
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "detail": "example", "instance": "example", "status": 1, "title": "example", "type": "example"}Unprocessable: the body or the change is invalid. The errors are keyed by member.
Media typeapplication/problem+json
A validation problem: the messages by member (or by JSON Pointer for a patch).
object
errors
object
key
additional properties
Array<string>
status
integer format: int32
title
string
type
string
key
additional properties
Example generated
{ "errors": { "additionalProperty": [ "example" ] }, "status": 1, "title": "example", "type": "example"}