Agents
Set the agent's redirects and scopes
Replace the redirects, the scopes, or both. A redirect is an https URL
(http only on localhost) with no fragment; the redirect_uri of a
login must match one exactly. An agent may have up to 10. Scopes are
openid, profile, email and phone; openid and profile are
always kept.
PATCH
/
v1
/
oauth2_client
Set the agent's redirects and scopes
curl --request PATCH \
--url https://api.staging.relayapp.im/v1/oauth2_client \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"redirect_uris": [
"<string>"
],
"scopes": []
}
'{
"client": {
"client_id": "<string>",
"redirect_uris": [
"<string>"
],
"scopes": [
"openid"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"client_secret": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}Authorizations
Bearer token authentication. Include your API token in the Authorization header.
Format: Authorization: Bearer <your-token>
Body
application/json
Maximum array length:
10An OpenID Connect scope a Log in with Relay client may ask for. birthdate asks for the person's birthday as the OpenID birthdate claim (YYYY-MM-DD, or 0000-MM-DD when they gave no year).
Available options:
openid, profile, email, phone, birthdate ⌘I
Set the agent's redirects and scopes
curl --request PATCH \
--url https://api.staging.relayapp.im/v1/oauth2_client \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"redirect_uris": [
"<string>"
],
"scopes": []
}
'{
"client": {
"client_id": "<string>",
"redirect_uris": [
"<string>"
],
"scopes": [
"openid"
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"client_secret": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}{
"error": {
"status": 123,
"code": 123,
"message": "<string>",
"doc_url": "<string>",
"retry_after": 123
},
"success": true,
"trace_id": "<string>"
}