AgLeader Credentials

Form of an AgLeader Credentials resource:

{
"accessToken": "str",
"refreshToken": "str",
"publicKey": "str",
"privateKey": "str"
}

All HTTP methods should be prepended by this service's endpoint:

https://api.withleaf.io/services/usermanagement/api

See below the REST resources and their endpoints available in this service.

Endpoints

DescriptionEndpoints
Get the AgLeader credentialsGET /users/{leafUserId}/ag-leader-credentials
Create a AgLeader credentialsPOST /users/{leafUserId}/ag-leader-credentials
Delete AgLeader credentialsDELETE /users/{leafUserId}/ag-leader-credentials

AgLeader Credentials Endpoints

Get the AgLeader credentials

 GET /users/{leafUserId}/ag-leader-credentials

Get the AgLeader credentials of the Leaf User based on its id and returns a JSON with the credentials. If during background processing we detect that this credential is no longer valid, the value of the status will be changed.

Request examples

curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/ag-leader-credentials'

Response

{
"id": "str",
"status": "str",
"createdTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"accessToken": "str",
"refreshToken": "str",
"publicKey": "str",
"privateKey": "str"
}

Create a AgLeader credentials

 POST /users/{leafUserId}/ag-leader-credentials

Create a AgLeader credentials for the Leaf User.

Request body

{
"accessToken": "str",
"refreshToken": "str",
"publicKey": "str",
"privateKey": "str"
}

Request examples

curl -X POST \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{ "accessToken": "str","refreshToken": "str","publicKey":"str", "privateKey":"str"}' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/ag-leader-credentials'

Response

A AgLeader Credentials with status.

{
"id": "str",
"status": "str",
"createdTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"accessToken": "str",
"refreshToken": "str",
"publicKey": "str",
"privateKey": "str"
}

Delete AgLeader credentials

 DELETE /users/{leafUserId}/ag-leader-credentials

Delete Leaf User's AgLeader credentials.

Request examples

curl -X DELETE \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/ag-leader-credentials'

Troubleshooting

With these endpoints, you can do some troubleshooting to see your credential's health.

Events

 GET /users/{leafUserId}/ag-leader-credentials/events

Get the logs of the provider credential based on the LeafUserId sent.

Request examples

curl -X GET \
-H 'Authorization: Bearer YOUR_TOKEN' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}
/ag-leader-credentials/events'

Response

[
{
"body": "string",
"createdDate": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"headers": "string",
"id": "string",
"statusCode": "int"
}
]
warning

The logs are available only for 30 days and once the credential is deleted or disassociated with the Leaf User, the logs are no longer available.

Edit this page