GET /oauth/auz/grants/{GrantID}/client/picture

Returns the avatar image for the OAuth client, for display on the Authorization page where the resource owner authorizes the grant.

Authorization Roles/Permissions: Must be the resource owner.

This topic includes the following sections:

HTTP Method

GET

Back to top

URL

https://{oauth-provider-url}/oauth/auz/grants/{GrantID}/client/picture

Back to top

Sample Request

The example below shows a request for the client avatar for the specified grant ID.

Request URL

https://{oauth-provider-url}/oauth/auz/grants/ge6ij9k4fbea/client/picture

Sample request headers

GET /oauth/auz/grants/ge6ij9k4fbea/client/picture HTTP/1.1
Accept: image/png,image/*;q=0.8,*/*;q=0.5

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept image/jpg

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
GrantID Path string Required The unique ID for a specific instance of an OAuth grant.
size Query integer Required The size, in pixels, for the width or height of the avatar image (the image should always be square). We recommend a size of 75 pixels.

Back to top

Response

If successful, this operation returns HTTP status code 200, with the client avatar image in JPG format.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Content-Type: image/jpeg
Expires: Wed, 22 Jul 2015 14:23:30 GMT

Sample response body

The response body is the avatar image file.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type image/jpg

Back to top

Response Body

The response body is the image file for the client.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
404 The resource could not be found. You would get this if the image is not available.
500 An error occurred processing the call.

More information about Enterprise API Platform API error messages.

Back to top

Related Topics