Skip to content

Palisade API (2.0)

The Palisade API enables programmatic interaction with the various features of the Palisade platform

Click here for the API docs
Download OpenAPI description
palisade-api.json
palisade-api.yaml
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/

Sandbox server (uses TESTNET data, private keys and accounts)

https://api.sandbox.palisade.co/

Palisade server (uses MAINNET data, private keys and accounts)

https://api.palisade.co/

Addresses

Used to manage addresses

Operations

Allow Addresses (deprecated)

Used to manage legacy allow addresses

API Credentials

Used to manage credentials

Operations

Approvals

Used to manage approvals

Operations

Approvers

Used to manage approvers

Operations

Audit

Used to manage configuration for audit

Operations

Backup

Used to manage backups

Operations

Balances

Used to view balances

Operations

Compliance

Used to manage compliance

Operations

Counterparties

Used to manage counterparties

Operations

Devices

Used to manage devices

Operations

Information

Used to view information about the platform

Operations

MPC - Memberships

Used to manage MPC memberships

Operations

MPC - Quorums

Used to manage MPC quorums

Operations

MPC - Sessions

Used to manage MPC sessions

Operations

Organizations

Used to manage organizations

Operations

Policies

Used to manage connections policies

Operations

Rates

Used to retrieve rates

Operations

Sweep Configurations

Used to manage sweep configurations

Operations

Tags

Used to manage organization tags

Operations

Transactions

Used to manage transactions

Operations

Transactions - XRP

Used to manage XRP specific transactions

Operations

Users

Used to manage users

Operations

List users

Request

List users

Security
TokenAuth
Query
rolestring

The role to filter by

Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users?role=ADMINISTRATOR' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
usersArray of objects(v2User)
Response
application/json
{
  "users": [
    { … }
  ]
}

Create a user

Request

Create a new user

Security
TokenAuth
Bodyapplication/jsonrequired
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "Joe",
    "lastName": "Bloggs",
    "email": "jbloggs@gmail.com",
    "roles": [
      "ADMINISTRATOR"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
createdBystringrequired

The ID of the user who created this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the user was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring(date-time)required

The date and time the user was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
blockedBystring

The ID of the user who blocked this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockedReasonstring

The reason the user was blocked

Example: "Lost device"
authLoginCountinteger(int32)

The number of time the user has logged in

Example: 10
authLastLoginstring(date-time)

The date and time the user last logged in

Example: "2022-03-29T10:22:22.420Z"
authLastPasswordResetstring(date-time)

The date and time the user last reset their password

Example: "2022-03-29T10:22:22.420Z"
authLastIpstring

The last IP address from which this user logged in

Example: "192.168.0.1"
picturestring

A link to the users gravatar image

Example: "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png"
proposedFirstNamestring

The proposed first name for the user

Example: "Joe"
proposedUpdatedBystring

The ID of the user who proposed the update

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
proposedLastNamestring

The proposed last name for the user

Example: "Bloggs"
proposedRolesArray of strings(v2Role)

The proposed roles for the user

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
proposedBlockedReasonstring

The proposed reason the user was blocked

Example: "Lost device"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com",
  "roles": [
    "ADMINISTRATOR"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "blockedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "blockedReason": "Lost device",
  "authLoginCount": 10,
  "authLastLogin": "2022-03-29T10:22:22.420Z",
  "authLastPasswordReset": "2022-03-29T10:22:22.420Z",
  "authLastIp": "192.168.0.1",
  "picture": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png",
  "proposedFirstName": "Joe",
  "proposedUpdatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "proposedLastName": "Bloggs",
  "proposedRoles": [
    "ADMINISTRATOR"
  ],
  "proposedBlockedReason": "Lost device"
}

List user info

Request

List user info

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/info \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
usersArray of objects(v2UserInfo)
Response
application/json
{
  "users": [
    { … }
  ]
}

Get user

Request

Get a user

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
createdBystringrequired

The ID of the user who created this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the user was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring(date-time)required

The date and time the user was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
blockedBystring

The ID of the user who blocked this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockedReasonstring

The reason the user was blocked

Example: "Lost device"
authLoginCountinteger(int32)

The number of time the user has logged in

Example: 10
authLastLoginstring(date-time)

The date and time the user last logged in

Example: "2022-03-29T10:22:22.420Z"
authLastPasswordResetstring(date-time)

The date and time the user last reset their password

Example: "2022-03-29T10:22:22.420Z"
authLastIpstring

The last IP address from which this user logged in

Example: "192.168.0.1"
picturestring

A link to the users gravatar image

Example: "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png"
proposedFirstNamestring

The proposed first name for the user

Example: "Joe"
proposedUpdatedBystring

The ID of the user who proposed the update

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
proposedLastNamestring

The proposed last name for the user

Example: "Bloggs"
proposedRolesArray of strings(v2Role)

The proposed roles for the user

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
proposedBlockedReasonstring

The proposed reason the user was blocked

Example: "Lost device"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com",
  "roles": [
    "ADMINISTRATOR"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "blockedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "blockedReason": "Lost device",
  "authLoginCount": 10,
  "authLastLogin": "2022-03-29T10:22:22.420Z",
  "authLastPasswordReset": "2022-03-29T10:22:22.420Z",
  "authLastIp": "192.168.0.1",
  "picture": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png",
  "proposedFirstName": "Joe",
  "proposedUpdatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "proposedLastName": "Bloggs",
  "proposedRoles": [
    "ADMINISTRATOR"
  ],
  "proposedBlockedReason": "Lost device"
}

Delete users

Request

Delete a user

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
object(v2DeleteUserResponse)
Response
application/json
{}

Update users

Request

Update a user

Security
TokenAuth
Path
idstringrequired

The user ID

Bodyapplication/jsonrequired
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "Joe",
    "lastName": "Bloggs"
  }'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
createdBystringrequired

The ID of the user who created this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the user was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring(date-time)required

The date and time the user was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
blockedBystring

The ID of the user who blocked this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockedReasonstring

The reason the user was blocked

Example: "Lost device"
authLoginCountinteger(int32)

The number of time the user has logged in

Example: 10
authLastLoginstring(date-time)

The date and time the user last logged in

Example: "2022-03-29T10:22:22.420Z"
authLastPasswordResetstring(date-time)

The date and time the user last reset their password

Example: "2022-03-29T10:22:22.420Z"
authLastIpstring

The last IP address from which this user logged in

Example: "192.168.0.1"
picturestring

A link to the users gravatar image

Example: "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png"
proposedFirstNamestring

The proposed first name for the user

Example: "Joe"
proposedUpdatedBystring

The ID of the user who proposed the update

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
proposedLastNamestring

The proposed last name for the user

Example: "Bloggs"
proposedRolesArray of strings(v2Role)

The proposed roles for the user

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
proposedBlockedReasonstring

The proposed reason the user was blocked

Example: "Lost device"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com",
  "roles": [
    "ADMINISTRATOR"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "blockedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "blockedReason": "Lost device",
  "authLoginCount": 10,
  "authLastLogin": "2022-03-29T10:22:22.420Z",
  "authLastPasswordReset": "2022-03-29T10:22:22.420Z",
  "authLastIp": "192.168.0.1",
  "picture": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png",
  "proposedFirstName": "Joe",
  "proposedUpdatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "proposedLastName": "Bloggs",
  "proposedRoles": [
    "ADMINISTRATOR"
  ],
  "proposedBlockedReason": "Lost device"
}

Get user info

Request

Get a users info

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/info' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com"
}

List authentication methods

Request

List a users authentication methods

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/mfa' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
idstringrequired

The ID of the authentication method

Example: "webauthn-roaming|dev_o8x1jtp0FTt7b35V"
typestringrequired

The type of the authentication method

Example: "webauthn-roaming"
namestringrequired

A human-readable label to identify the authentication method

Example: "My first key"
createdAtstring(date-time)required

The date and time the authenticator was created

Example: "2022-03-29T10:22:22.420Z"
lastAuthedAtstring(date-time)required

The date and time the authenticator was last used

Example: "2022-03-29T10:22:22.420Z"
]
Response
application/json
[
  {
    "id": "webauthn-roaming|dev_o8x1jtp0FTt7b35V",
    "type": "webauthn-roaming",
    "name": "My first key",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "lastAuthedAt": "2022-03-29T10:22:22.420Z"
  }
]

Delete authentication methods

Request

Delete all authentication methods for a user

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/mfa' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
object(v2DeleteUserAuthMethodsResponse)
Response
application/json
{}

Trigger password reset

Request

Triggers a password reset and sends an email to the user

Security
TokenAuth
Path
idstringrequired

The user ID

curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/password' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
object(v2TriggerPasswordResetResponse)
Response
application/json
{}

Update user role

Request

Update a users role

Security
TokenAuth
Path
idstringrequired

The user ID

Bodyapplication/jsonrequired
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/role' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "roles": [
      "ADMINISTRATOR"
    ]
  }'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
createdBystringrequired

The ID of the user who created this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the user was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring(date-time)required

The date and time the user was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
blockedBystring

The ID of the user who blocked this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockedReasonstring

The reason the user was blocked

Example: "Lost device"
authLoginCountinteger(int32)

The number of time the user has logged in

Example: 10
authLastLoginstring(date-time)

The date and time the user last logged in

Example: "2022-03-29T10:22:22.420Z"
authLastPasswordResetstring(date-time)

The date and time the user last reset their password

Example: "2022-03-29T10:22:22.420Z"
authLastIpstring

The last IP address from which this user logged in

Example: "192.168.0.1"
picturestring

A link to the users gravatar image

Example: "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png"
proposedFirstNamestring

The proposed first name for the user

Example: "Joe"
proposedUpdatedBystring

The ID of the user who proposed the update

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
proposedLastNamestring

The proposed last name for the user

Example: "Bloggs"
proposedRolesArray of strings(v2Role)

The proposed roles for the user

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
proposedBlockedReasonstring

The proposed reason the user was blocked

Example: "Lost device"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com",
  "roles": [
    "ADMINISTRATOR"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "blockedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "blockedReason": "Lost device",
  "authLoginCount": 10,
  "authLastLogin": "2022-03-29T10:22:22.420Z",
  "authLastPasswordReset": "2022-03-29T10:22:22.420Z",
  "authLastIp": "192.168.0.1",
  "picture": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png",
  "proposedFirstName": "Joe",
  "proposedUpdatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "proposedLastName": "Bloggs",
  "proposedRoles": [
    "ADMINISTRATOR"
  ],
  "proposedBlockedReason": "Lost device"
}

Update user status

Request

Update a users status

Security
TokenAuth
Path
idstringrequired

The user ID

Bodyapplication/jsonrequired
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
reasonstring

The reason for the status change

Example: "The user lost their device"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/users/{id}/status' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "CREATED",
    "reason": "The user lost their device"
  }'

Responses

Bodyapplication/json
idstringrequired

The user ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
firstNamestringrequired

The users first name

Example: "Joe"
lastNamestringrequired

The users last name

Example: "Bloggs"
emailstringrequired

The users email

Example: "jbloggs@gmail.com"
rolesArray of strings(v2Role)required

The roles that the user has

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
createdBystringrequired

The ID of the user who created this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the user was created

Example: "2022-03-29T10:22:22.420Z"
updatedBystringrequired

The ID of the user who updated this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
updatedAtstring(date-time)required

The date and time the user was updated

Example: "2022-03-29T10:22:22.420Z"
statusstring(v2UserStatus)required
Enum"CREATED""INVITED""ACTIVATED""BLOCKED""REJECTED""DELETED""ERROR""CREATION_APPROVAL_PENDING""CREATION_APPROVAL_COMPLETE""BLOCK_APPROVAL_PENDING"
blockedBystring

The ID of the user who blocked this user

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockedReasonstring

The reason the user was blocked

Example: "Lost device"
authLoginCountinteger(int32)

The number of time the user has logged in

Example: 10
authLastLoginstring(date-time)

The date and time the user last logged in

Example: "2022-03-29T10:22:22.420Z"
authLastPasswordResetstring(date-time)

The date and time the user last reset their password

Example: "2022-03-29T10:22:22.420Z"
authLastIpstring

The last IP address from which this user logged in

Example: "192.168.0.1"
picturestring

A link to the users gravatar image

Example: "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png"
proposedFirstNamestring

The proposed first name for the user

Example: "Joe"
proposedUpdatedBystring

The ID of the user who proposed the update

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
proposedLastNamestring

The proposed last name for the user

Example: "Bloggs"
proposedRolesArray of strings(v2Role)

The proposed roles for the user

Items Enum"ADMINISTRATOR""APPROVER""AUDITOR""OWNER""PROPOSER""VIEWER"
Example: ["ADMINISTRATOR"]
proposedBlockedReasonstring

The proposed reason the user was blocked

Example: "Lost device"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "firstName": "Joe",
  "lastName": "Bloggs",
  "email": "jbloggs@gmail.com",
  "roles": [
    "ADMINISTRATOR"
  ],
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "status": "CREATED",
  "blockedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "blockedReason": "Lost device",
  "authLoginCount": 10,
  "authLastLogin": "2022-03-29T10:22:22.420Z",
  "authLastPasswordReset": "2022-03-29T10:22:22.420Z",
  "authLastIp": "192.168.0.1",
  "picture": "https://s.gravatar.com/avatar/621f114992de896519becb13976039cd?s=480&r=pg&d=https%3A%2F%2Fcdn.auth0.com%2Favatars%2Fka.png",
  "proposedFirstName": "Joe",
  "proposedUpdatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "proposedLastName": "Bloggs",
  "proposedRoles": [
    "ADMINISTRATOR"
  ],
  "proposedBlockedReason": "Lost device"
}

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

Wallets

Used to manage wallets

Operations

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations