Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions main/config/navigation/generated/myaccount.en.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@
"docs/api/myaccount/connected-accounts/get-connected-accounts-connections",
"docs/api/myaccount/connected-accounts/delete-connected-account"
]
},
{
"group": "Profile",
"pages": [
"docs/api/myaccount/profile/get-profile"
]
}
]
}
6 changes: 6 additions & 0 deletions main/config/navigation/generated/myaccount.fr-ca.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@
"docs/fr-ca/api/myaccount/connected-accounts/get-connected-accounts-connections",
"docs/fr-ca/api/myaccount/connected-accounts/delete-connected-account"
]
},
{
"group": "Profile",
"pages": [
"docs/fr-ca/api/myaccount/profile/get-profile"
]
}
]
}
6 changes: 6 additions & 0 deletions main/config/navigation/generated/myaccount.ja-jp.json
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@
"docs/ja-jp/api/myaccount/connected-accounts/get-connected-accounts-connections",
"docs/ja-jp/api/myaccount/connected-accounts/delete-connected-account"
]
},
{
"group": "Profile",
"pages": [
"docs/ja-jp/api/myaccount/profile/get-profile"
]
}
]
}
2 changes: 1 addition & 1 deletion main/docs/api/myaccount/_metadata.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"oasVersion": "1.606.0",
"oasVersion": "1.610.0",
"snippetVersion": "0.0.5"
}
11 changes: 11 additions & 0 deletions main/docs/api/myaccount/profile/get-profile.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
openapi: /docs/oas/myaccount/myaccount-api-oas.json GET /profile
playground: simple
deprecated: false
---

import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx";
import { Scopes } from "/snippets/ApiScopes.jsx";

<ApiReleaseLifecycle releaseLifecycle="beta" />
<Scopes scopes={["read:me:profile"]} />
11 changes: 11 additions & 0 deletions main/docs/fr-ca/api/myaccount/profile/get-profile.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
openapi: /docs/oas/myaccount/myaccount-api-oas.json GET /profile
playground: simple
deprecated: false
---

import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx";
import { Scopes } from "/snippets/ApiScopes.jsx";

<ApiReleaseLifecycle releaseLifecycle="beta" />
<Scopes scopes={["read:me:profile"]} />
11 changes: 11 additions & 0 deletions main/docs/ja-jp/api/myaccount/profile/get-profile.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
openapi: /docs/oas/myaccount/myaccount-api-oas.json GET /profile
playground: simple
deprecated: false
---

import { ApiReleaseLifecycle } from "/snippets/ApiReleaseLifecycle.jsx";
import { Scopes } from "/snippets/ApiScopes.jsx";

<ApiReleaseLifecycle releaseLifecycle="beta" />
<Scopes scopes={["read:me:profile"]} />
187 changes: 187 additions & 0 deletions main/docs/oas/myaccount/myaccount-api-oas.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@
"name": "organizations",
"description": "Organizations",
"x-displayName": "Organizations"
},
{
"name": "profile",
"description": "Profile",
"x-displayName": "Profile"
}
],
"paths": {
Expand Down Expand Up @@ -2036,6 +2041,76 @@
"x-operation-name": "list",
"x-codeSamples": []
}
},
"/profile": {
"get": {
"description": "Retrieve the authenticated user's profile attributes available for self-service management, with a per-field access policy indicating read/write eligibility.",
"operationId": "getProfile",
"parameters": [
{
"$ref": "#/components/parameters/HeaderCorrelationId"
},
{
"$ref": "#/components/parameters/HeaderTraceparent"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetProfileResponseContent"
}
}
},
"description": "Successfully retrieved profile.",
"headers": {
"x-ratelimit-limit": {
"$ref": "#/components/headers/XRateLimitLimitHeader"
},
"x-ratelimit-reset": {
"$ref": "#/components/headers/XRateLimitResetHeader"
},
"x-ratelimit-remaining": {
"$ref": "#/components/headers/XRateLimitRemainingHeader"
},
"x-correlation-id": {
"$ref": "#/components/headers/CorrelationIdHeader"
},
"traceparent": {
"$ref": "#/components/headers/TraceparentHeader"
}
}
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
}
},
"security": [
{
"Bearer-DPoP": [
"read:me:profile"
]
}
],
"tags": [
"profile"
],
"summary": "Get the authenticated user's profile.",
"x-release-lifecycle": "beta",
"x-operation-group": "Profile",
"x-operation-name": "get",
"x-codeSamples": []
}
}
},
"components": {
Expand Down Expand Up @@ -4890,6 +4965,118 @@
"organizations"
],
"additionalProperties": false
},
"UserMetadata": {
"type": "object",
"description": "Data related to the user that does not affect the application's core functionality. Only the subset of keys accessible for self-service management is returned.",
"additionalProperties": true
},
"ProfileFieldAccessEnum": {
"type": "string",
"enum": [
"read_write",
"read_only"
],
"description": "Whether the authenticated user may write this field."
},
"ProfileFieldSourceEnum": {
"type": "string",
"enum": [
"user",
"idp",
"system"
],
"description": "Who is the authoritative source for this field's value."
},
"ProfilePolicyEntry": {
"type": "object",
"description": "Write-eligibility descriptor for a single profile field.",
"required": [
"label",
"access",
"source"
],
"additionalProperties": false,
"properties": {
"label": {
"type": "string",
"description": "Human-readable field name."
},
"access": {
"$ref": "#/components/schemas/ProfileFieldAccessEnum"
},
"source": {
"$ref": "#/components/schemas/ProfileFieldSourceEnum"
},
"reason": {
"type": "string",
"description": "Present only when access is read_only. Explains why the field is not writable."
}
}
},
"ProfilePolicy": {
"type": "object",
"description": "Per-field write-eligibility keyed by RFC 6901 JSON Pointer (e.g. /email).",
"additionalProperties": {
"$ref": "#/components/schemas/ProfilePolicyEntry"
}
},
"GetProfileResponseContent": {
"type": "object",
"description": "The authenticated user's profile attributes available for self-service management, with a per-field access policy indicating read/write eligibility.",
"required": [],
"additionalProperties": false,
"properties": {
"given_name": {
"type": "string",
"description": "Given name/first name/forename of this user."
},
"family_name": {
"type": "string",
"description": "Family name/last name/surname of this user."
},
"name": {
"type": "string",
"description": "Name of this user."
},
"nickname": {
"type": "string",
"description": "Preferred nickname or alias of this user."
},
"picture": {
"type": "string",
"description": "URL to picture, photo, or avatar of this user."
},
"email": {
"type": "string",
"format": "email",
"description": "Email address of this user."
},
"phone_number": {
"type": "string",
"description": "Phone number for this user. Follows the <a href=\"https://en.wikipedia.org/wiki/E.164\">E.164 recommendation</a>."
},
"username": {
"type": "string",
"description": "Username of this user."
},
"user_metadata": {
"$ref": "#/components/schemas/UserMetadata"
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when this user was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Date and time when this user was last updated/modified."
},
"profile_policy": {
"$ref": "#/components/schemas/ProfilePolicy"
}
}
}
},
"responses": {
Expand Down
Loading