GET User Details.

GET

/api/web/custom/namespaces/{namespace}/whoami

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/namespaces/example/whoami';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/web/custom/namespaces/example/whoami \
  --header 'Authorization: <Authorization>'

GET fetches user information based on the username header from the request context this API is also called as WhoAmI.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace of the user object (namespace where the user object is stored).

Responses

200

A successful response.

application/json

Get User Detail Response

Detailed information about user including role assigments and other details for tenant.

object

access_type

string

default: UNKNOWN_ACCESS

Allowed values: UNKNOWN_ACCESS DIRECT_ACCESS MSP_ACCESS DELEGATED_ACCESS SUPPORT_ACCESS

active_plan_transition_uid

Active plan transition id

UUID of the plan transition request which is currently in progress. This field is empty if there is no such request.

string

<= 1024 characters

addon_service_status

Addon Service Status

Addon service state and access for the user.

object

billing_flags

Collection of flags informing the customer of any billing related problems, such as overdue invoices.

Array<object>

Billing Feature Indicator

Single instance of a billing indicator. It informs the customer of any problems with their billing, including failed payments, overdue invoices, or missing valid payment methods.

object

action

string

default: NO_ACTION

Allowed values: NO_ACTION ADD_NEW_PAYMENT_METHOD CONTACT_US

additional_info

Additional info

Any description (such as error message) related to this billing feature.

string

<= 1024 characters

billing_flag

string

default: VALID_PAYMENT_METHOD

Allowed values: VALID_PAYMENT_METHOD OVERDUE_INVOICE LAST_TRANSACTION_STATUS PAYMENT_METHOD_EXPIRED PAYMENT_METHOD_INSUFFICIENT_FUNDS PAYMENT_METHOD_PRIMARY_DECLINED PAYMENT_METHOD_CVC_INVALID PAYMENT_METHOD_ZIP_INVALID PAYMENT_METHOD_INSUFFICIENT_FUNDS_SECONDARY_CHARGED PAYMENT_METHOD_PRIMARY_EXPIRED_SECONDARY_CHARGED PAYMENT_METHOD_PRIMARY_DECLINED_SECONDARY_CHARGED PAYMENT_METHOD_BOTH_PAYMENT_METHOD_FAILED PAYMENT_METHOD_GENERIC_FAILURE PAYMENT_METHOD_GENERIC_ADD_FAILURE

failed

Failed

If true then the billing feature is failed and to be looked into.

boolean format: boolean

billing_plan_name

Billing plan name

Billing plan name of the plan template the tenant is subscribed to (Free plan, Teams Plan, Organization Plan, …)

string

<= 1024 characters

cname

Cname x-displayName: "CName" x-example: "web" CName via tenant will be accessed from url. <cname>.<domain>

CName via tenant will be accessed from URL. .

string

<= 1024 characters

company

Company name x-displayName: "Company" x-example: "Acme Ltd." Legal name of the company the user/tenant belongs to

Legal name of the company the user/tenant belongs to.

string

<= 1024 characters

creation_timestamp

Creation Timestamp x-displayName: "Creation Timestamp" User object creation timestamp

User object creation timestamp.

string format: date-time

<= 1024 characters

disabled

Disabled

If set to true user is completely disabled including IDM.

boolean format: boolean

domain_owner

Domain Owner

Domain owner is the first user who registered or signed up the associated Tenant. User created via signup flow will have this value set to true. Few restrictions apply to this user w.r.t role update and deletion.

boolean format: boolean

email

Email

Email of the user object.

string format: email

<= 1024 characters /^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}$/

environment

Environment

Current global controller deployment enviroment.

string

<= 1024 characters

feature_flags

Feature flag type

Feature flag that shows whether this feature should be enabled on UI for the current plan.

Array<object>

FeatureFlagType x-displayName: "Feature and its Status for the Tenant's Plan"

object

disabled

disabled

X-displayName “Disabled” status of whether this feature should be disabled for current plan.

boolean format: boolean

name

feature's name

Name of the feature.

string

>= 6 characters <= 1024 characters

first_name

First name

First name of the customer.

string

<= 1024 characters

group_names

Groups

Group list must be associated to this user.

Array<string>

idm_type

string

default: SSO

Allowed values: SSO VOLTERRA_MANAGED UNDEFINED

last_login_timestamp

Last login timestamp

Last login timestamp when user successfully login to access VoltConsole.

string format: date-time

<= 1024 characters

last_name

Last name

Last name of the customer.

string

<= 1024 characters

msp_managed

object

msp_id

msp_id

Msp ID for the tenant.

string

<= 1024 characters

node_type

string

default: MspNodeTypeUnknown

Allowed values: MspNodeTypeUnknown MspNodeTypeChild MspNodeTypeParent

parent_tenant_id

Parent Tenant ID

Hold parent tenant ID.

string

<= 1024 characters

tier

tier

Tier of tenant in MSP tree.

integer format: int64

name

Name

Username of the user.

string

>= 6 characters <= 1024 characters

namespace

Namespace

Namespace of the user object (namespace where the user object is stored).

string

>= 6 characters <= 1024 characters

namespace_access

object

namespace_role_map

Namespace Role Map

List of all the roles for the entity in the namespaces Required: YES.

object

namespace_roles

Namespace roles

Directly attached namespace roles for the user This field is deprecated, refer to namespace_access field for the access of the user.

Array<object>

Namespace role

Allows linking namespaces and roles.

object

namespace

Namespace

Namespace the role applies to ’*’ value implies all namespaces Required: YES.

string

>= 6 characters <= 256 characters

role

Role

Users role for this namespace Required: YES.

string

<= 256 characters

original_tenant

Original Tenant

Returns original tenant ID that the user belongs if request header exist for original tenant else regular tenant ID.

string

<= 1024 characters

plan_type

string

default: FREE

Allowed values: FREE INDIVIDUAL TEAM ORGANIZATION PLAN_TYPE_UNSPECIFIED

self_managed

object

signup_origin

string

default: ORIGIN_UNKNOWN

Allowed values: ORIGIN_UNKNOWN ORIGIN_F5XC ORIGIN_AWS ORIGIN_ASB

state

string

default: StateUndefined

Allowed values: StateUndefined StateCreating StateCreateFailed StateActive StateDisabled

sync_mode

string

default: SELF

Allowed values: SELF SCIM

tenant

Tenant

Tenant will represent ID of the tenant that is being accessed.

string

>= 6 characters <= 1024 characters

tenant_flags

Tenant Flags

Contains information about tenant configuration for giving UI instructions to show specific sections.

object

tenant_state

Tenant State

Contains information about current state of the tenant.

string

<= 1024 characters

tenant_type

string

default: UNKNOWN

Allowed values: UNKNOWN FREEMIUM ENTERPRISE

tile_access

Tile Access

Primary Navigation Tile access based on Plan and Addon service subscription.

object

tos_accepted

tos_accepted

Tos accepted version.

string

<= 1024 characters

tos_accepted_at

tos_accepted_at

Tos accepted timestamp.

string format: date-time

<= 1024 characters

tos_current_version

tos_current_version

Tos current version.

string

<= 1024 characters

tos_version

tos_version

Tos accepted version.

string

<= 1024 characters

type

string

default: USER

Allowed values: USER SERVICE DEBUG

user_uuid

User UUId

User UUID of the currently logged in user.

string

<= 1024 characters

Example

{
  "access_type": "UNKNOWN_ACCESS",
  "billing_flags": [
    {
      "action": "NO_ACTION",
      "billing_flag": "VALID_PAYMENT_METHOD"
    }
  ],
  "idm_type": "SSO",
  "msp_managed": {
    "node_type": "MspNodeTypeUnknown"
  },
  "plan_type": "FREE",
  "signup_origin": "ORIGIN_UNKNOWN",
  "state": "StateUndefined",
  "sync_mode": "SELF",
  "tenant_type": "UNKNOWN",
  "type": "USER"
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET User Details.

Authorizations

Parameters

Path Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated