Add-ons1

Alerts2

API Tokens4

Autoscaling3

Cert Management8

Connections3

Deployment2

Deployment Target5

Discounts3

Domain Management10

Environment19

Environment Activity3

Environment Backups5

Environment Type2

Environment Variables5

Grants1

Invoices2

MFA8

Orders4

Organization Invitations3

Organization Management5

Organization Members5

Organization Projects6

Organizations6

PhoneNumber2

Profiles4

Project5

Project Activity3

Project Invitations3

Project Settings2

Project Variables5

Records2

References5

Regions2

Repository5

Routing2

Runtime Operations1

Source Operations2

SSH Keys3

Subscriptions13

Support4

System Information2

Team Access8

Teams10

Third-Party Integrations5

User Access10

User Profiles7

Users10

Vouchers2

User Profiles

Update a user profile

Update a user profile, supplying one or more key/value pairs to to change.

patch/profiles/{userId}

Request

Base URL
https://api.upsun.com
Auth
OAuth 2
Authorization codehttps://auth.api.platform.sh/oauth2/authorize
Token URLhttps://auth.api.platform.sh/oauth2/token
TypeScript
https://skmtc.dev/upsun/apis/upsun-com-rest-api/docs/profiles/:userId/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

The UUID of the user

Request body

display_namestring

The user's display name.

usernamestring

The user's username.

current_passwordstring

The user's current password.

passwordstring

The user's new password.

company_typestring

The company type.

company_namestring

The name of the company.

vat_numberstring

The vat number of the user.

company_rolestring

The role of the user in the company.

marketingboolean

Flag if the user agreed to receive marketing communication.

ui_colorschemestring

The user's chosen color scheme for user interfaces. Available values are 'light' and 'dark'.

default_catalogstring

The URL of a catalog file which overrides the default.

project_options_urlstring

The URL of an account-wide project options file.

picturestring

Url of the user's picture.

Response

A User profile object

idstring uuid

The user's unique ID.

display_namestring

The user's display name.

emailstring email

The user's email address.

usernamestring

The user's username.

type'user' | 'organization'

The user's type (user/organization).

picturestring url

The URL of the user's picture.

company_typestring

The company type.

company_namestring

The name of the company.

currencystring

A 3-letter ISO 4217 currency code (assigned according to the billing address).

vat_numberstring

The vat number of the user.

company_rolestring

The role of the user in the company.

website_urlstring

The user or company website.

new_uiboolean

Whether the new UI features are enabled for this user.

ui_colorschemestring

The user's chosen color scheme for user interfaces.

default_catalogstring

The URL of a catalog file which overrides the default.

project_options_urlstring

The URL of an account-wide project options file.

marketingboolean

Flag if the user agreed to receive marketing communication.

created_atstring date-time

The timestamp representing when the user account was created.

updated_atstring date-time

The timestamp representing when the user account was last modified.

billing_contactstring email

The e-mail address of a contact to whom billing notices will be sent.

invoicedboolean

The customer is invoiced.

Changes

No recorded changes to this operation across all 1 revision of this API.