APITree - API User-API

APITree / User-API

User-API

The User-API provides access to your profile data. You can read your profile, update it and change your password using the API.

To access the API endpoints you need an API token with the OAuth scope profile. Find out how to create an API token.

Resources

profile

Profile related operations

POST

/profile/changePassword

Changes the user password

Request

Header

Name	Data Type	Description
`x-apitree-password`	string Minimum: 6	The user password. Required for `type=user`. Must match the following regex pattern: `(?=.\d)(?=.[a-z])(?=.*[A-Z])`. In case of a social account the OAuth access token must be provided.

Responses

204No Content

400Account disabled / Invalid password

Body

Name	Data Type	Description
`ErrorResponse`	object

Properties

`message`	string	Response message containing detailed information about the error
`code`	integer	HTTP Status Code

Examples

{
    "code": 401,
    "message": "Access denied"
}

404Account not found

GET

/profile

Gets the profile data of the authenticated user

Responses

200OK

Body

Name	Data Type	Description
`Profile`	object

Properties

`createdAt`	dateTime Read-only	UTC timestamp the user was created - ISO 8601
`company`	string Maximum: 120	The company name the user is working for
`webUrl`	string	An absolute URL to the user's personal site / blog
`pictureUrl`	string	An absolute URL to the user's picture, photo, or avatar / the organization's logo
`location`	string Maximum: 120	The city in which the user is located
`countryCode`	string Minimum: 2 Maximum: 2	The country/region in which the user is located as ISO-3166 2-letter country code - e.g. `DE` for `Germany`. Required for paid plans.
`displayName`	string Maximum: 120	The name displayed for the user / organization.
`emailVerified`	boolean Default value: `false`	Flag to check if the user has verified his email address
`email`	string	Primary email address. Optional for organizations created by the `community`.
`nickname`	string Maximum: 60	URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case.
`accountType`	string Default value: `user` Allowed values: - `user` - `organization`	The type of the account
`id`	string Read-only	Unique user `id`

Examples

{
    "id": "100001",
    "accountType": "user",
    "nickname": "nils",
    "email": "nils.friedrichs@apitree.com",
    "emailVerified": true,
    "displayName": "Nils Friedrichs",
    "firstname": "Nils",
    "lastname": "Friedrichs",
    "countryCode": "DE",
    "location": "Berlin",
    "webUrl": "https:\/\/www.friedrichs-it.de",
    "company": "APITree",
    "createdAt": "2017-10-01T10:10:10+00:00"
}

PUT

/profile

Updates the profile data of the authenticated user

Request

Body

Name	Data Type	Description
`Profile`	object

Properties

`createdAt`	dateTime Read-only	UTC timestamp the user was created - ISO 8601
`company`	string Maximum: 120	The company name the user is working for
`webUrl`	string	An absolute URL to the user's personal site / blog
`pictureUrl`	string	An absolute URL to the user's picture, photo, or avatar / the organization's logo
`location`	string Maximum: 120	The city in which the user is located
`countryCode`	string Minimum: 2 Maximum: 2	The country/region in which the user is located as ISO-3166 2-letter country code - e.g. `DE` for `Germany`. Required for paid plans.
`displayName`	string Maximum: 120	The name displayed for the user / organization.
`emailVerified`	boolean Default value: `false`	Flag to check if the user has verified his email address
`email`	string	Primary email address. Optional for organizations created by the `community`.
`nickname`	string Maximum: 60	URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case.
`accountType`	string Default value: `user` Allowed values: - `user` - `organization`	The type of the account
`id`	string Read-only	Unique user `id`

Examples

{
    "id": "100001",
    "accountType": "user",
    "nickname": "nils",
    "email": "nils.friedrichs@apitree.com",
    "emailVerified": true,
    "displayName": "Nils Friedrichs",
    "firstname": "Nils",
    "lastname": "Friedrichs",
    "countryCode": "DE",
    "location": "Berlin",
    "webUrl": "https:\/\/www.friedrichs-it.de",
    "company": "APITree",
    "createdAt": "2017-10-01T10:10:10+00:00"
}

Responses

204No Content

400Invalid profile data supplied

Body

Name	Data Type	Description
`ErrorResponse`	object

Properties

`message`	string	Response message containing detailed information about the error
`code`	integer	HTTP Status Code

Examples

{
    "code": 401,
    "message": "Access denied"
}

Models

ErrorResponse

Profile

Properties

Name	Data Type	Description
`createdAt`	dateTime Read-only	UTC timestamp the user was created - ISO 8601
`company`	string Maximum: 120	The company name the user is working for
`webUrl`	string	An absolute URL to the user's personal site / blog
`pictureUrl`	string	An absolute URL to the user's picture, photo, or avatar / the organization's logo
`location`	string Maximum: 120	The city in which the user is located
`countryCode`	string Minimum: 2 Maximum: 2	The country/region in which the user is located as ISO-3166 2-letter country code - e.g. `DE` for `Germany`. Required for paid plans.
`displayName`	string Maximum: 120	The name displayed for the user / organization.
`emailVerified`	boolean Default value: `false`	Flag to check if the user has verified his email address
`email`	string	Primary email address. Optional for organizations created by the `community`.
`nickname`	string Maximum: 60	URI compliant username in ASCII format. Allowed characters are lower case (a-z), upper case (A-Z), digits (0-9), hyphens (-), dots (.) and underscore (_). The nickname must be unique regardless of upper and lower case.
`accountType`	string Default value: `user` Allowed values: - `user` - `organization`	The type of the account
`id`	string Read-only	Unique user `id`

Examples

{
    "id": "100001",
    "accountType": "user",
    "nickname": "nils",
    "email": "nils.friedrichs@apitree.com",
    "emailVerified": true,
    "displayName": "Nils Friedrichs",
    "firstname": "Nils",
    "lastname": "Friedrichs",
    "countryCode": "DE",
    "location": "Berlin",
    "webUrl": "https:\/\/www.friedrichs-it.de",
    "company": "APITree",
    "createdAt": "2017-10-01T10:10:10+00:00"
}

Authentication

Oauth2

'OAuth' Authentication Scheme
Reference: RFC5849, Section 3.5.1

JWT token from the Auth-API

Flow: password
Token URL: https://auth-api.apitree.com/oauth2/token
Scopes:

profile: View basic profile data

Contact

Name	`ApiTree GmbH`
Email	`support@apitree.com`

Metadata (Technical Details)

API Version 1.2.2

Comments

Loading comments ...