Get a specific portal user
GEThttps://api.iot.telenor.com/identity-access-management/domains/:id/portal-users/:portalUserId
Get a specific portal user.
Request
Path Parameters
Identifies the domain in Keycloak.
Identifies the portal user.
Responses
- 200
- 401
- 403
- 404
The portal user was successfully retrieved.
- application/json
- Schema
- Example (auto)
Schema
Id of the portal user.
When the user was created, specified in ISO 8601.
Sets a user to active if true or inactive if false.
First name of the portal user.
John
Last name of the portal user.
Doe
The email address of the portal user.
Possible values: >= 5 characters
and <= 254 characters
john.doe@example.com
The phone number of the portal user.
Possible values: >= 4 characters
and <= 20 characters
460760000001
Hierarchical identifier for a domain. Used to identify which domain a user belongs to and whether a user has access to a domain.
abcd1234-efgh1234
roles object[]required
domain objectrequired
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"createdTimestamp": "2024-07-29T15:51:28.071Z",
"enabled": true,
"firstName": "John",
"lastName": "Doe",
"email": "john.doe@example.com",
"phoneNumber": 460760000001,
"domainId": "abcd1234-efgh1234",
"roles": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Subscription ordering",
"description": "Allows user to order new subscriptions and follow up existing orders."
}
],
"domain": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"name": "Acme"
}
}
Invalid or missing access token (JWT).
Not authorized to access this resource.
Entity not found.
- application/json
- Schema
- Example (auto)
Schema
Human readable description of the error
Requested resource does not exist.
Following errors are defined for this service:
400 Bad Request Errors
INVALID_REQUEST_BODY
Request body is invalid. Must contain valid JSON.
INVALID_EMAIL
Invalid value for the property email
. Must be a valid email.
INVALID_CLIENT_ID_PREFIX
Invalid value for the property clientIdPrefix
. Allowed characters are A-Z, a-z, 0-9, as well as underscore (_) and hyphen (-). Client id must not be longer than 128 characters.
NOT_ALLOWED_TO_MANAGE_SELF
Not allowed to manage your own user.
INVALID_USER_STATUS
Invalid value for the property enabled
. Boolean values are allowed.
INVALID_SEARCH_VALUE
Invalid value for the query parameter search
. Most Unicode characters are allowed..
INVALID_OFFSET_VALUE
Invalid value for the query parameter offset
. Number between 0 and 1000000 is allowed.
INVALID_LIMIT_VALUE
Invalid value for the query parameter limit
. Number between 0 and 100 is allowed.
INVALID_ROLES_ARRAY
Invalid value for the property roles
. Must be of type array ([]) containing between 0 and 100 roles.
INVALID_SOLUTIONS_ARRAY
Invalid value for the property solutions
. Must be of type array ([]) containing between 0 and 100 solutions.
INVALID_SOLUTION
Invalid value for one or more entries in the solutions
array. Alphabetic characters, numbers, and some special characters are allowed.
INVALID_USER_ROLES
Invalid content in property roles
. Each role must contain property id
with UUID formatting and property type
specifying whether the role is global
or custom
.
INVALID_SYSTEM_USER_ROLES
Invalid content in property roles
. Each role must contain property id
with UUID formatting and property type
with value global
.
INVALID_GLOBAL_ROLE
At least one of the requested global roles is invalid.
INVALID_NAME
Invalid value for the property name
. Alphabetic characters, numbers, and some special characters are allowed.
INVALID_PHONE_NUMBER
Invalid value for the property phoneNumber
. Must be of type string containing between 4 and 20 numbers.
INVALID_PARENT_DOMAIN_ID
Invalid value for the property parentId
. Must contain a string with UUID formatting.
INVALID_DOMAIN_ID
Invalid value for the property 'domainId'. Must contain a string.
PARENT_DOMAIN_NOT_FOUND
The domain specified in the property parentId
could not be found.
401 Unauthorized Errors
INVALID_TOKEN
Access token is not valid.
403 Forbidden Errors
FORBIDDEN_ERROR
Not authorized to access this resource.
FORBIDDEN_ROLE_UPDATE
Forbidden operation since it would result in the addition or removal of a role the requesting user does not have themselves.
FORBIDDEN_IDENTICAL_DOMAIN_UPDATE
User already belongs to the specified domain.
FORBIDDEN_SOLUTION
Forbidden operation since it would result in the addition or removal of a solution the requesting user does not have themselves.
FORBIDDEN_ROOT_DOMAIN_SOLUTIONS_UPDATE
Not allowed to change solutions for root domain.
404 Not Found Errors
RESOURCE_NOT_FOUND
Requested resource does not exist.
409 Conflict Errors
CONFLICT_ERROR
Resource already exists.
500 Internal Server Errors
SERVICE_ERROR
Error occurred when communicating with another service. Please try again or contact your system administrator if this problem persists.
ACCESS_TOKEN_ERROR
Unexpected error with access token. Please try logging out and in again or contact your system administrator if this problem persists.
CREATE_DOMAIN_ERROR
Domain could not be created due to an unexpected internal error. Please try again or contact your system administrator if this problem persists.
503 Service Unavailable Errors
CRITICAL_SERVICE_ERROR
Unable to communicate with another service. Please try again or contact your system administrator if this problem persists.
RESOURCE_NOT_FOUND
Epoch timestamp specifying when error occurred
1560954657369
{
"description": "Requested resource does not exist.",
"errorCode": "RESOURCE_NOT_FOUND",
"timestamp": 1560954657369
}
Authorization: oauth2
name: oAuth2type: oauth2scopes:openid
flows: { "authorizationCode": { "tokenUrl": "/auth/realms/telenor-iot/protocol/openid-connect/token", "authorizationUrl": "/auth/realms/telenor-iot/protocol/openid-connect/auth", "scopes": { "openid": "openid" } }, "clientCredentials": { "tokenUrl": "/auth/realms/telenor-iot/protocol/openid-connect/token", "scopes": { "openid": "openid" } } }
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.iot.telenor.com/identity-access-management/domains/:id/portal-users/:portalUserId");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());