--- title: "Get your own user profile" method: GET path: "/api/admin/user/profile" tags: ["Users"] --- # Get your own user profile `GET /api/admin/user/profile` Detailed information about the current user root role and project membership ## Response `200` profileSchema - ProfileSchema — User profile overview - `rootRole` RoleSchema, required — A role holds permissions to allow Unleash to decide what actions a role holder is allowed to perform - `id` integer, required — The role id - `type` string, required — A role can either be a global root role (applies to all projects) or a project role - `name` string, required — The name of the role - `description` string — A more detailed description of the role and what use it's intended for - `project` string, nullable — What project the role belongs to - `projects` string[], required — Which projects this user is a member of - `groups` GroupItemSchema[], required — Experimental: Which groups this user is a member of - `id` integer — The group id - `name` string, required — The name of the group - `description` string, nullable — A custom description of the group - `mappingsSSO` string[] — A list of SSO groups that should map to this Unleash group - `rootRole` number, nullable — A role id that is used as the root role for all users in this group. This can be either the id of the Viewer, Editor or Admin role. - `scimId` string, nullable — The SCIM ID of the group, only present if managed by SCIM - `subscriptions` string[], required — Which email subscriptions this user is subscribed to - `features` FeatureSchema[], required — Deprecated, always returns empty array - `name` string, required — Unique feature name - `type` string — Type of the flag e.g. experiment, kill-switch, release, operational, permission - `description` string, nullable — Detailed description of the feature - `archived` boolean — `true` if the feature is archived - `project` string — Name of the project the feature belongs to - `enabled` boolean — `true` if the feature is enabled, otherwise `false`. - `stale` boolean — `true` if the feature is stale based on the age and feature type, otherwise `false`. - `favorite` boolean — `true` if the feature was favorited, otherwise `false`. - `impressionData` boolean — `true` if the impression data collection is enabled for the feature, otherwise `false`. - `createdAt` string, date-time, nullable — The date the feature was created - `createdBy` object — User who created the feature flag - `id` integer, required — The user id - `name` string, required — Name of the user - `imageUrl` string, required — URL used for the user profile image - `archivedAt` string, date-time, nullable — The date the feature was archived - `environments` FeatureEnvironmentSchema[] — The list of environments where the feature can be used - `name` string, required — The name of the environment - `featureName` string — The name of the feature - `environment` string — The name of the environment - `type` string — The type of the environment - `enabled` boolean, required — `true` if the feature is enabled for the environment, otherwise `false`. - `sortOrder` number — The sort order of the feature environment in the feature environments list - `variantCount` number — The number of defined variants - `strategies` FeatureStrategySchema[] — A list of activation strategies for the feature environment - `id` string — A uuid for the feature strategy - `name` string, required — The name or type of strategy - `title` string, nullable — A descriptive title for the strategy - `disabled` boolean, nullable — A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs - `featureName` string — The name or feature the strategy is attached to - `sortOrder` number — The order of the strategy in the list - `segments` number[] — A list of segment ids attached to the strategy - `constraints` ConstraintSchema[] — A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints - `contextName` string, required — The name of the context field that this constraint should apply to. - `operator` 'NOT_IN' | 'IN' | 'STR_ENDS_WITH' | 'STR_STARTS_WITH' | 'STR_CONTAINS' | 'NUM_EQ' | 'NUM_GT' | 'NUM_GTE' | 'NUM_LT' | 'NUM_LTE' | 'DATE_AFTER' | 'DATE_BEFORE' | 'SEMVER_EQ' | 'SEMVER_GT' | 'SEMVER_LT' | 'SEMVER_GTE' | 'SEMVER_LTE' | 'REGEX', required — The operator to use when evaluating this constraint. For more information about the various operators, refer to [the strategy constraint operator documentation](https://docs.getunleash.io/concepts/activation-strategies#constraint-operators). - `caseInsensitive` boolean — Whether the operator should be case sensitive or not. Defaults to `false` (being case sensitive). - `inverted` boolean — Whether the result should be negated or not. If `true`, will turn a `true` result into a `false` result and vice versa. - `values` string[] — The context values that should be used for constraint evaluation. Use this property instead of `value` for properties that accept multiple values. - `value` string — The context value that should be used for constraint evaluation. Use this property instead of `values` for properties that only accept single values. - `variants` StrategyVariantSchema[] — Strategy level variants - `name` string, required — The variant name. Must be unique for this feature flag - `weight` integer, required — The weight is the likelihood of any one user getting this variant. It is an integer between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/concepts/feature-flag-variants#variant-weight) for more information - `weightType` 'variable' | 'fix', required — Set to `fix` if this variant must have exactly the weight allocated to it. If the type is `variable`, the weight will adjust so that the total weight of all variants adds up to 1000. Refer to the [variant weight documentation](https://docs.getunleash.io/concepts/feature-flag-variants#variant-weight). - `stickiness` string, required — The [stickiness](https://docs.getunleash.io/concepts/feature-flag-variants#variant-stickiness) to use for distribution of this variant. Stickiness is how Unleash guarantees that the same user gets the same variant every time - `payload` object — Extra data configured for this variant - `type` 'json' | 'csv' | 'string' | 'number', required — The type of the value. Commonly used types are string, number, json and csv. - `value` string, required — The actual value of payload - `parameters` ParametersSchema — A list of parameters for a strategy - `variants` VariantSchema[] — A list of variants for the feature environment - `name` string, required — The variants name. Is unique for this feature flag - `weight` number, required — The weight is the likelihood of any one user getting this variant. It is a number between 0 and 1000. See the section on [variant weights](https://docs.getunleash.io/concepts/feature-flag-variants#variant-weight) for more information - `weightType` 'variable' | 'fix' — Set to fix if this variant must have exactly the weight allocated to it. If the type is variable, the weight will adjust so that the total weight of all variants adds up to 1000 - `stickiness` string — [Stickiness](https://docs.getunleash.io/concepts/feature-flag-variants#variant-stickiness) is how Unleash guarantees that the same user gets the same variant every time - `payload` object — Extra data configured for this variant - `type` 'json' | 'csv' | 'string' | 'number', required — The type of the value. Commonly used types are string, number, json and csv. - `value` string, required — The actual value of payload - `overrides` OverrideSchema[] — Overrides assigning specific variants to specific users. The weighting system automatically assigns users to specific groups for you, but any overrides in this list will take precedence. - `contextName` string, required — The name of the context field used to determine overrides - `values` string[], required — Which values that should be overriden - `changeRequestIds` number[] — Experimental. A list of change request identifiers for actionable change requests that are not Cancelled, Rejected or Approved. - `milestoneName` string — Experimental: The name of the currently active release plan milestone - `milestoneOrder` number — Experimental: The zero-indexed order of currently active milestone in the list of all release plan milestones - `totalMilestones` number — Experimental: The total number of milestones in the feature environment release plan - `lastSeenAt` string, date-time, nullable — The date when metrics where last collected for the feature environment - `hasStrategies` boolean — Whether the feature has any strategies defined. - `hasEnabledStrategies` boolean — Whether the feature has any enabled strategies defined. - `releasePlans` ReleasePlanSchema[] — Release plans for this feature environment - `id` string, required — The release plan/template's ID. Release template IDs are ulids. - `discriminator` 'plan', required — A field to distinguish between release plans and release templates. - `name` string, required — The name of the release template. - `description` string, nullable — A description of the release template. - `featureName` string, required — The name of the feature that uses this release plan. - `environment` string, required — The environment that this release plan is for. - `createdByUserId` number, required — Release template: The ID of the user who created this template. - `createdAt` string, date-time, required — The date and time that the release template was created. - `activeMilestoneId` string, nullable — The ID of the currently active milestone in this release plan. - `milestones` ReleasePlanMilestoneSchema[], required — A list of the milestones in this release template. - `id` string, required — The milestone's ID. Milestone IDs are ulids. - `name` string, required — The name of the milestone. - `sortOrder` integer, required — The order of the milestone in the release plan. - `releasePlanDefinitionId` string, required — The ID of the release plan/template that this milestone belongs to. - `startedAt` string, date-time, nullable — The date and time when the milestone was started. - `transitionCondition` object, nullable — The condition configuration for the transition - `intervalMinutes` integer, required — The interval in minutes before transitioning - `progressionExecutedAt` string, date-time, nullable — The date and time when the milestone progression was executed. - `pausedAt` string, date-time, nullable — The date and time when the milestone was paused. - `strategies` ReleasePlanMilestoneStrategySchema[] — A list of strategies that are attached to this milestone. - `id` string, required — The milestone strategy's ID. Milestone strategy IDs are ulids. - `milestoneId` string, required — The ID of the milestone that this strategy belongs to. - `sortOrder` number, required — The order of the strategy in the list - `title` string, nullable — A descriptive title for the strategy - `name` string, required — The name of the strategy type - `strategyName` string, required — The name of the strategy type - `parameters` ParametersSchema — A list of parameters for a strategy - `constraints` ConstraintSchema[] — A list of the constraints attached to the strategy. See https://docs.getunleash.io/concepts/activation-strategies#constraints - … - `variants` CreateStrategyVariantSchema[] — Strategy level variants - … - `segments` number[] — Ids of segments to use for this strategy - `disabled` boolean, nullable — A toggle to disable the strategy. defaults to false. Disabled strategies are not evaluated or returned to the SDKs - `releasePlanTemplateId` string, required — The ID of the release plan template that this release plan is based on. - `safeguards` ReleasePlanSafeguardSchema[] — An array of safeguards configured for this release plan. - `id` string, required — The unique ULID identifier for this safeguard - `action` object, required — The action to take when the safeguard is triggered. - `type` string, required — The type of action to perform. - `id` string, required — The ID of the release plan this safeguard applies to. - `triggerCondition` SafeguardTriggerConditionSchema, required — The condition that triggers the safeguard. - `operator` '>' | '<', required — The comparison operator for the threshold check. - `threshold` number, required — The threshold value to compare against. - `impactMetric` object, required — The metric configuration used to evaluate the safeguard condition. - `id` string, required — The unique identifier for this impact metric - `metricName` string, required — The Prometheus metric series to query. It includes both unleash prefix and metric type and display name - `timeRange` 'hour' | 'day' | 'week' | 'month', required — The time range for the metric data. - `aggregationMode` 'rps' | 'count' | 'avg' | 'sum' | 'p95' | 'p99' | 'p50', required — The aggregation mode for the metric data. - `labelSelectors` object, required — The selected labels and their values for filtering the metric data. - `source` 'internal' | 'external' — The Prometheus data source for this metric. Internal is the Unleash-managed Prometheus, external is a customer-provided Prometheus instance. Defaults to internal if not specified. - `safeguards` FeatureEnvironmentSafeguardSchema[] — Safeguards for this feature environment - `id` string, required — The unique ULID identifier for this safeguard - `action` object, required — Disable a feature in an environment when triggered. - `type` string, required — The type of action to perform. - `featureName` string, required — The feature flag name this safeguard applies to. - `environment` string, required — The environment this safeguard applies to. - `project` string, required — The project this safeguard applies to. - `triggerCondition` SafeguardTriggerConditionSchema, required — The condition that triggers the safeguard. - `operator` '>' | '<', required — The comparison operator for the threshold check. - `threshold` number, required — The threshold value to compare against. - `impactMetric` object, required — The metric configuration used to evaluate the safeguard condition. - `id` string, required — The unique identifier for this impact metric - `metricName` string, required — The Prometheus metric series to query. It includes both unleash prefix and metric type and display name - `timeRange` 'hour' | 'day' | 'week' | 'month', required — The time range for the metric data. - `aggregationMode` 'rps' | 'count' | 'avg' | 'sum' | 'p95' | 'p99' | 'p50', required — The aggregation mode for the metric data. - `labelSelectors` object, required — The selected labels and their values for filtering the metric data. - `source` 'internal' | 'external' — The Prometheus data source for this metric. Internal is the Unleash-managed Prometheus, external is a customer-provided Prometheus instance. Defaults to internal if not specified. - `yes` integer — How many times the feature evaluated to true (enabled) - `no` integer — How many times the feature evaluated to false (disabled) - `tags` TagSchema[], nullable — The list of feature tags - `value` string, required — The value of the tag. - `type` string, required — The [type](https://docs.getunleash.io/concepts/feature-flags#tags) of the tag - `color` string, nullable — The hexadecimal color code for the tag type. - `children` string[] — The list of child feature names. This is an experimental field and may change. - `lifecycle` object — Current lifecycle stage of the feature - `stage` 'initial' | 'pre-live' | 'live' | 'completed' | 'archived', required — The name of the current lifecycle stage - `status` string, nullable — The name of the detailed status of a given stage. E.g. completed stage can be kept or discarded. - `enteredStageAt` string, date-time, required — When the feature entered this stage - `dependencies` object[] — The list of parent dependencies. This is an experimental field and may change. - `feature` string, required — The name of the parent feature - `enabled` boolean — Whether the parent feature is enabled or not - `variants` string[] — The list of variants the parent feature should resolve to. Only valid when feature is enabled. - `collaborators` object — Information related to users who have made changes to this feature flage. - `users` object[], required — Users who have made any changes to this feature flags. The list is sorted in reverse chronological order (most recent changes first) - `id` integer, required — The user's id - `name` string, required — The user's name, username, or email (prioritized in that order). If none of those are present, this property will be set to the string `unknown` - `imageUrl` string, required — The URL to the user's profile image - `links` object[] — The list of links. This is an experimental field and may change. - `id` string, required — The id of the link - `url` string, required — The URL the feature is linked to - `title` string, nullable — The description of the link - `feature` string — The name of the feature this link belongs to - `canChangePassword` boolean, required — Whether the current user has a local password that can be changed. ## Other responses - `400` — The request data does not match what we expect. - `401` — Authorization information is missing or invalid. Provide a valid API token as the `authorization` header, e.g. `authorization:*.*.my-admin-token`. --- [API](https://skmtc.net/unleash/apis/unleash-api-3.md) · [All operations](https://skmtc.net/unleash/apis/unleash-api-3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unleash/unleash-api-3/versions/b2c3116e633e/schema)