Agvance Credentials

Form of a Agvance Credentials resource:

{
"apiKey": "str",
"clientEnvironment": "STAGE or PRODUCTION",
"databaseId": "str",
"password": "str",
"username": "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 Agvance credentialsGET /users/{leafUserId}/agvance-credentials
Create a Agvance credentialsPOST /users/{leafUserId}/agvance-credentials
Delete Agvance credentialsDELETE /users/{leafUserId}/agvance-credentials

Agvance Credentials Endpoints

Get the Agvance credentials

 GET /users/{leafUserId}/agvance-credentials

Get the Agvance 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}/agvance-credentials'

Response

{
"id": "str",
"status": "str",
"createdTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"clientEnvironment": "STAGE or PRODUCTION",
"username": "str",
"password": "str",
"databaseId": "str",
"sessionId": "str",
"apiKey": "str"
}

Create a Agvance credentials

 POST /users/{leafUserId}/agvance-credentials

Create a Agvance credentials for the Leaf User.

Request body

{
"apiKey": "str",
"clientEnvironment": "STAGE or PRODUCTION",
"databaseId": "str",
"password": "str",
"username": "str"
}

Request examples

curl -X POST \
-H 'Authorization: Bearer YOUR_TOKEN' \
-d '{"apiKey": "str", "clientEnvironment": "STAGE or PRODUCTION", "databaseId": "str", "password": "str", "username": "str"}' \
'https://api.withleaf.io/services/usermanagement/api/users/{leafUserId}/agvance-credentials'

Response

A Agvance Credentials with status.

{
"id": "str",
"status": "str",
"createdTime": "yyyy-MM-dd'T'HH:mm:ss.SSSSSS'Z'",
"clientEnvironment": "STAGE or PRODUCTION",
"username": "str",
"password": "str",
"databaseId": "str",
"sessionId": "str",
"apiKey": "str"
}

Delete Agvance credentials

 POST /users/{leafUserId}/agvance-credentials

Delete Leaf User's Agvance credentials.

Request examples

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

Troubleshooting

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

Events

 GET /users/{leafUserId}/agvance-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}
/agvance-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