Skip to content

Commit 4d83edb

Browse files
committed
Add Phone Number Endpoints
1 parent 0fe70db commit 4d83edb

File tree

1 file changed

+160
-1
lines changed

1 file changed

+160
-1
lines changed

openapi.yaml

Lines changed: 160 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2631,7 +2631,7 @@ paths:
26312631
email address. Linode Managed can monitor any service or software stack reachable over TCP or HTTP. See
26322632
our [Linode Managed guide](/docs/platform/linode-managed/)
26332633
to learn more.
2634-
operationId: enableAccountManged
2634+
operationId: enableAccountManaged
26352635
x-linode-cli-action: enable-managed
26362636
security:
26372637
- personalAccessToken: []
@@ -17463,6 +17463,165 @@ paths:
1746317463
- lang: CLI
1746417464
source: >
1746517465
linode-cli sshkey delete 42
17466+
/profile/phone-number:
17467+
x-linode-cli-command: profile
17468+
delete:
17469+
x-linode-grant: read_write
17470+
tags:
17471+
- Profile
17472+
summary: Phone Number Delete
17473+
description: |
17474+
Delete the verified phone number for the User making this request.
17475+
17476+
Use this command to opt out of SMS messages for the requesting User after a phone number has been verified with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
17477+
operationId: deleteProfilePhone
17478+
x-linode-cli-command: phone-delete
17479+
security:
17480+
- personalAccessToken: []
17481+
- oauth:
17482+
- account:read_write
17483+
responses:
17484+
'200':
17485+
description: >
17486+
Phone number deletion request successful.
17487+
content:
17488+
application/json:
17489+
schema:
17490+
type: object
17491+
default:
17492+
$ref: '#/components/responses/ErrorResponse'
17493+
x-code-samples:
17494+
- lang: Shell
17495+
source: >
17496+
curl -H "Content-Type: application/json" \
17497+
-H "Authorization: Bearer $TOKEN" \
17498+
-X DELETE \
17499+
https://api.linode.com/v4/profile/phone-number
17500+
- lang: CLI
17501+
source: >
17502+
linode-cli profile phone-delete
17503+
post:
17504+
x-linode-grant: read_write
17505+
tags:
17506+
- Profile
17507+
summary: Phone Number Verification Code Send
17508+
description: |
17509+
Send a one-time verification code via SMS message to the submitted phone number. Providing your phone number helps ensure you can securely access your Account in case other ways to connect are lost. Your phone number is only used to verify your identity by sending an SMS message. Standard carrier messaging fees may apply.
17510+
17511+
* By accessing this command you are opting in to receive SMS messages. You can opt out of SMS messages by using the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command after your phone number is verified.
17512+
17513+
* Verification codes are valid for 10 minutes after they are sent.
17514+
17515+
* Subsequent requests made prior to code expiration result in sending the same code.
17516+
17517+
Once a verification code is received, verify your phone number with the **Phone Number Verify** ([POST /profile/phone-number/verify](/docs/api/profile/#phone-number-verify)) command.
17518+
operationId: sendProfilePhoneVerificationCode
17519+
x-linode-cli-command: phone-code-send
17520+
security:
17521+
- personalAccessToken: []
17522+
- oauth:
17523+
- account:read_write
17524+
requestBody:
17525+
description: Enter a phone number and country code for verification.
17526+
content:
17527+
application/json:
17528+
schema:
17529+
required:
17530+
- iso_code
17531+
- phone_number
17532+
type: object
17533+
properties:
17534+
iso_code:
17535+
type: string
17536+
description: The two-letter ISO 3166 country code associated with the phone number.
17537+
example: US
17538+
phone_number:
17539+
type: string
17540+
description: A valid phone number.
17541+
format: phone
17542+
example: 555-555-5555
17543+
responses:
17544+
'200':
17545+
description: >
17546+
Phone number verification code request successful.
17547+
content:
17548+
application/json:
17549+
schema:
17550+
type: object
17551+
default:
17552+
$ref: '#/components/responses/ErrorResponse'
17553+
x-code-samples:
17554+
- lang: Shell
17555+
source: >
17556+
curl -H "Content-Type: application/json" \
17557+
-H "Authorization: Bearer $TOKEN" \
17558+
-X POST -d '{
17559+
"iso_code": "US",
17560+
"phone_number": "555-555-5555"
17561+
}' \
17562+
https://api.linode.com/v4/profile/phone-number
17563+
- lang: CLI
17564+
source: >
17565+
linode-cli profile phone-code-send \
17566+
--iso-code US \
17567+
--phone-number 555-555-5555
17568+
/profile/phone-number/verify:
17569+
x-linode-cli-command: profile
17570+
post:
17571+
x-linode-grant: read_write
17572+
tags:
17573+
- Profile
17574+
summary: Phone Number Verify
17575+
description: |
17576+
Verify a phone number by confirming the one-time code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
17577+
17578+
* Verification codes are valid for 10 minutes after they are sent.
17579+
17580+
* Only the same User that made the verification code request can use that code with this command.
17581+
17582+
Once completed, the verified phone number is assigned to the User making the request. To change the verified phone number for a User, first use the **Phone Number Delete** ([DELETE /profile/phone-number](/docs/api/profile/#phone-number-delete)) command, then begin the verification process again with the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
17583+
operationId: checkProfilePhoneVerificationCode
17584+
x-linode-cli-command: phone-verify
17585+
security:
17586+
- personalAccessToken: []
17587+
- oauth:
17588+
- account:read_write
17589+
requestBody:
17590+
description: Enter a phone verification code for confirmation.
17591+
content:
17592+
application/json:
17593+
schema:
17594+
required:
17595+
- otp_code
17596+
type: object
17597+
properties:
17598+
otp_code:
17599+
type: string
17600+
description: The one-time, six-digit code received via SMS message after accessing the **Phone Verification Code Send** ([POST /profile/phone-number](/docs/api/profile/#phone-number-verification-code-send)) command.
17601+
example: "US"
17602+
responses:
17603+
'200':
17604+
description: >
17605+
Phone number verification successful.
17606+
content:
17607+
application/json:
17608+
schema:
17609+
type: object
17610+
default:
17611+
$ref: '#/components/responses/ErrorResponse'
17612+
x-code-samples:
17613+
- lang: Shell
17614+
source: >
17615+
curl -H "Content-Type: application/json" \
17616+
-H "Authorization: Bearer $TOKEN" \
17617+
-X POST -d '{
17618+
"otp_code": "123456"
17619+
}' \
17620+
https://api.linode.com/v4/profile/phone-number/verify
17621+
- lang: CLI
17622+
source: >
17623+
linode-cli profile phone-verify \
17624+
--otp_code 123456
1746617625
/profile/preferences:
1746717626
x-linode-cli-command: profile
1746817627
get:

0 commit comments

Comments
 (0)