Pexip Engage API documentation

Get authorized profile picture upload URL

GET /employees/profile-picture-url

OAuth2

Get an authorized URL for uploading a profile picture

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
X-Correlation-Id string

Unique identifier to allow referencing a particular transaction or event chain

Minimum length is 1.
Accept-Language string

Returns the requested resources translated according to the passed languages (see translatable resources)

Minimum length is 1.

Query parameters

file-name string Required

Minimum length is 1.

Responses

• 200 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes
  
  url string(uri) Required
  
  Minimum length is 1.
  
  authorizedUrl string(uri) Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /employees/profile-picture-url

curl \
 -X GET https://api.pexipengage.com/enterprises/acme/employees/profile-picture-url?file-name=string \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *"

Response examples (200)

{
  "data": {
    "url": "https://wwww.example.net/abc123",
    "authorizedUrl": "https://wwww.example.net/abc123"
  }
}