Stara Credentials

Form of a Stara Credentials resource:

{
"apiKey": "str",
"accessToken": "str",
"accessTokenClient": "str",
"refreshToken": "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 Stara credentialsGET /users/{leafUserId}/stara-credentials
Create a Stara credentialsPOST /users/{leafUserId}/stara-credentials
Delete Stara credentialsDELETE /users/{leafUserId}/stara-credentials

Stara Credentials Endpoints

Get the Stara credentials

 GET /users/{leafUserId}/stara-credentials

Get the Stara 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}/stara-credentials'

Response

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

Create a Stara credentials

 POST /users/{leafUserId}/stara-credentials

Create a Stara credentials for the Leaf User.

Request body

{
"apiKey": "str",
"accessToken": "str",
"accessTokenClient": "str",
"refreshToken": "str"
}

Request examples

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

Response

A Stara Credentials with status.

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

Delete Stara credentials

 DELETE /users/{leafUserId}/stara-credentials

Delete Leaf User's Stara credentials.

Request examples

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

Troubleshooting

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

Events

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