/api/accounts/{accountId}

Prev Next
Get
/api/accounts/{accountId}
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

OK

Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
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
id
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
account
object (Contracts.Connect.Results.Identities.SelectAccountJson)
code
string | null
id
string | null
name
string | null
countClients
integer (int32) | null
countPlayers
integer (int32) | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonComponents) | null
object
code
string | null
id
string | null
name
string | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonComponent) | null
object
code
string | null
id
string | null
name
string | null
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonRoles) | null
object
code
string | null
id
string | null
name
string | null
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonRole) | null
object
code
string | null
id
string | null
name
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
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
id
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
account
object (Contracts.Connect.Results.Identities.SelectAccountJson)
code
string | null
id
string | null
name
string | null
countClients
integer (int32) | null
countPlayers
integer (int32) | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonComponents) | null
object
code
string | null
id
string | null
name
string | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonComponent) | null
object
code
string | null
id
string | null
name
string | null
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonRoles) | null
object
code
string | null
id
string | null
name
string | null
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonRole) | null
object
code
string | null
id
string | null
name
string | null
Expand All
object
success
object (Contracts.Common.Jsons.Common.SuccessJson)
ok
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
id
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
account
object (Contracts.Connect.Results.Identities.SelectAccountJson)
code
string | null
id
string | null
name
string | null
countClients
integer (int32) | null
countPlayers
integer (int32) | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonComponents) | null
object
code
string | null
id
string | null
name
string | null
components
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonComponent) | null
object
code
string | null
id
string | null
name
string | null
permission
string
Valid values[ "None", "Enabled", "Disabled", "AddAndEdit", "ViewOnly", "Hide", "Add", "Edit", "Remove" ]
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountResultJsonRoles) | null
object
code
string | null
id
string | null
name
string | null
roles
Array of object (Contracts.Connect.Results.Identities.SelectAccountsResultJsonRole) | null
object
code
string | null
id
string | null
name
string | null
401

Unauthorized

403

Forbidden

object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
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*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
object
type
string | null
title
string | null
status
integer (int32) | null
detail
string | null
instance
string | null
property*
500

Internal Server Error