/api/accounts/{accountId}

Updated on Aug 19, 2025
Published on Jul 23, 2025

2 minute(s) reading time

Prev Next

Delete

Security

OAuth

Authorization using OAuth2 with Client Credentials

FlowClient Credentials

Authorization URLhttps://identity.eu01.grassfish.com/connect/authorize

Token URLhttps://identity.eu01.grassfish.com/connect/token

Header parameters

x-correlationToken

string

x-clientId

string

Min length0

Max length128

x-onBehalfOf

string

Min length0

Max length24

api-version

string

Path parameters

accountId

stringRequired

Responses

200

Expand All

object

success

object (Contracts.Common.Jsons.Common.SuccessJson)

boolean

message

string | null

unauthorizedAccess

boolean | null

notFound

boolean | null

correlationToken

string | null

errors

Array of object (Contracts.Common.Jsons.Common.SuccessJsonError) | null

object

message

string | null

string

Valid values[ "InvalidDatePeriodEndDateBeforeStartDate", "NameAlreadyTaken", "ExternalIdAlreadyTaken" ]

fieldName

string | null

isRequired

boolean | null

isOutOfRange

boolean | null

isTaken

boolean | null

errorCode

string | null

defaultDisplayMessage

string | null

errorCode

string | null

details

object (Contracts.Common.Jsons.Common.ErrorDetailsJson)

message

string | null

defaultDisplayMessage

string | null

accounts

Array of object (Contracts.Common.Jsons.Refs.AccountRefJson) | null

object

Code

string | null

Min length0

Max length24

string | null

Min length0

Max length128

Name

string | null

Min length0

Max length50

externalId

string | null

400

Bad Request

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

401

Unauthorized

403

Forbidden

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

404

Not Found

object

type

string | null

title

string | null

status

integer (int32) | null

detail

string | null

instance

string | null

property*

500

Internal Server Error