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

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

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

Sample 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.

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

Header	Description
Accept	image/jpg

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.

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

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.

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

Header	Description
Content-Type	image/jpg

The response body is the image file for the client.

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.