Oauth clients
/oauth/members/{member}/clients [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.8900 | 6.3004 | xml, json |
Description
Create an OAuth client.
In practice the scope parameter must be specified, otherwise client access is limited to services like get self.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| name | The name of the client (informational) | yes | string | |
| app | The name of the app (informational) | no | string | |
| access-token-max-age | The max age of the access tokens in seconds | no | long | 1 hour |
| client-secret | The client secret | no | string | [random string] |
| client-uri | The URL for the client app (informational) | no | string | |
| confidential | Whether the client is capable of maintaining confidentiality of credentials | no | boolean | true |
| description | The description of this client (informational) | no | string | |
| grant-type | The grant type allowed for this client:[authorization_code|password|client_credentials] | no | string | authorization_code |
| identifier | The OAuth 2.0 client ID - 16 digit hexadecimal number (admin only) | no | string | [random hex number] |
| redirect-uri | The redirection URI specific to this client | no | url | |
| refresh-token-max-age | The max age of the refresh tokens in seconds | no | long | 30 days |
| scope | A space separated list of scopes allowed for this client e.g. openid profile email | no | string | |
| webhook-secret | The secret used for signing webhook requests (between 24 and 64 characters long) | no | string |
Permission
The member themselves or an administrator.
Response
<client-registration>
<client id="1"
identifier="2aa92c5a79baf3fe"
requires-consent="false"
confidential="false"
name="My app"
grant-type="authorization_code"
[created="2020-03-08T12:34:00+10:00"]
[modified="2020-03-10T11:24:00+10:00"]
[last-token="2020-05-10T10:28:00+10:00"]
[app="Timesheet"]
[webhook-secret="S0meP@ssw0d"]
[redirect-uri="http://example.org/login"]
[description="My example timesheet"]
[client-uri="http://example.org"]
[scope="openid profile email"]
access-token-max-age="7200"
refresh-token-max-age="0">
<member id="45" ...>
<fullname>John Smith</fullname>
</member>
</client>
</client-registration>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x1041 | Maximum number of clients for this member has been reached |
| 0x1042 | Maximum number of clients for server has been reached |
| 0x1043 | Client name or identifier already in use |
| 0x1044 | Identifier must be a 16 digit hexadecimal number |
| 0x1045 | Malformed redirect URI |
| 0x1047 | Invalid grant type |
| 0x1048 | Invalid scope |
| 0x1049 | The webhook-secret must be between 24 and 64 characters |
| 0x104A | Public clients cannot use the client_credentials grant type |