Get a user's geographic scope

get

https://api.doit.com/rbac/v1/customers/{targetCustomerId}/users/{userId}/geographic-scope

Returns the geographic scope assigned to a user who belongs to the target customer. The authenticated tenant must be the hierarchy root, and the target must be that root customer or one of its child customers. Targets outside that hierarchy are returned as not found. Requires the UsersManager permission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

targetCustomerId

string

required

length between 1 and 200

Customer ID within the authenticated tenant's hierarchy whose geographic scope is managed.

userId

string

required

length between 1 and 200

Unique user ID returned by GET /iam/v1/users that belongs to the target customer.

Headers

X-Tenant-Id

string

Customer (tenant) ID for the request. This is separate from authentication: you still pass your personal or service account API token in the Authorization header (Bearer <token>). See Get Started.

When to omit (most callers): If your personal or service account token belongs to a single customer, omit this header. The API resolves that customer from the token.

When to send: If your credential can access more than one customer, set X-Tenant-Id to the customer ID you want to act on. Omitting it returns 400 with code tenant_id_required. If the value conflicts with the tenants your credential may access, the request returns 400 with code tenant_id_mismatch. Prefer this header over the legacy customerContext query parameter, which only applies to legacy API keys and is ignored by personal and service account tokens.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

200OK

400Syntactically malformed request, missing required parameter, or unsupported parameter value.

401Missing or invalid credentials.

403Authenticated but not authorized to perform this request.

404The requested resource does not exist.

409The request conflicts with the current state of the resource.

429Request rate limit exceeded; retry after the indicated delay.

500Unexpected server error.

503Service temporarily unavailable; retry after the indicated delay.