Documentation forAccess Rights Manager

Account Read APIs

Get Accounts (GET)

Returns account details for the given account keys. The given <see cref="AccountModelOptions"/> specifies which optional properties of

Route

URI

/api/v1/Account

Method

GET

Result

JSON – IActionResult

Parameters

None

Example

GET http://localhost/api/v1/Account

Get All Accounts (GET)

Returns account details for all accounts of the given provider. The given <see cref="AccountModelOptions"/> specifies which optional properties of

Route

URI

/api/v1/Account/all

Method

GET

Result

JSON – AccountModel[]

Parameters

TechnologyProvider object:

Property

Type

Mandatory

Description

TechnologyKey

string

Yes

 

TechnologyDisplayName

string

Yes

 

ProviderName

string

Yes

 

Response Structure Returns AccountModel[] object containing:

  • ResourceTypeGuid: Guid value

  • SerializedAccountId: string value

  • UriKey: string value

  • DisplayName: string value

  • Provider: TechnologyProvider value

  • IsGroup: bool value

  • Sid: string value

  • Guid: Guid? value

  • Description: string value

  • Attributes: KeyValuePair<string, string>[] value

  • ExtendedAttributes: KeyValuePair<string, string>[] value

  • Children: string[] value

  • TypeId: int value

Example

GET http://localhost/api/v1/Account/all

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }

Get All Accounts (POST)

Returns account details for all accounts of the given provider. The given <see cref="AccountModelOptions"/> specifies which optional properties of

Route

URI

/api/v1/Account/all

Method

POST

Result

JSON – IActionResult

Request Payload

TechnologyProvider object:

Property

Type

Mandatory

Description

TechnologyKey

string

Yes

 

TechnologyDisplayName

string

Yes

 

ProviderName

string

Yes

 

Example

POST http://localhost/api/v1/Account/all Content-Type: application/json  {     "TechnologyKey": "sample",     "TechnologyDisplayName": "sample",     "ProviderName": "sample" }

Get Children (GET)

Gets the details of the child accounts (members) of the container account (group) specified by the given key.

Route

URI

/api/v1/Account/children

Method

GET

Result

JSON – AccountModel[]

Parameters

AccountModelOptions object:

Property

Type

Mandatory

Description

IncludeChildren

bool

No

Indicates if <see cref="AccountModel.Children"/> should be included.

IncludeProvider

bool

No

Indicates if <see cref="AccountModel.Provider"/> should be included.

IncludeAttributes

bool

No

Indicates if <see cref="AccountModel.Attributes"/> should be included.

UseRawAttributeValues

bool

No

Indicates if <see cref="AccountModel.Attributes"/> are used, they will be included as raw values and not translated into DisplayValue. This option must be used in conjunction with IncludeAttributes = true

ResolveAllGroups

bool

No

(Reserved, not activ) Resolve all user accounts of groups <para>Default = false</para>

Response Structure Returns AccountModel[] object containing:

  • ResourceTypeGuid: Guid value

  • SerializedAccountId: string value

  • UriKey: string value

  • DisplayName: string value

  • Provider: TechnologyProvider value

  • IsGroup: bool value

  • Sid: string value

  • Guid: Guid? value

  • Description: string value

  • Attributes: KeyValuePair<string, string>[] value

  • ExtendedAttributes: KeyValuePair<string, string>[] value

  • Children: string[] value

  • TypeId: int value

Example

GET http://localhost/api/v1/Account/children

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }

Get Parents (GET)

Gets the details of the parent accounts (group memberships) of the account specified by the given key.

Route

URI

/api/v1/Account/parents

Method

GET

Result

JSON – AccountModel[]

Parameters

AccountModelOptions object:

Property

Type

Mandatory

Description

IncludeChildren

bool

No

Indicates if <see cref="AccountModel.Children"/> should be included.

IncludeProvider

bool

No

Indicates if <see cref="AccountModel.Provider"/> should be included.

IncludeAttributes

bool

No

Indicates if <see cref="AccountModel.Attributes"/> should be included.

UseRawAttributeValues

bool

No

Indicates if <see cref="AccountModel.Attributes"/> are used, they will be included as raw values and not translated into DisplayValue. This option must be used in conjunction with IncludeAttributes = true

ResolveAllGroups

bool

No

(Reserved, not activ) Resolve all user accounts of groups <para>Default = false</para>

Response Structure Returns AccountModel[] object containing:

  • ResourceTypeGuid: Guid value

  • SerializedAccountId: string value

  • UriKey: string value

  • DisplayName: string value

  • Provider: TechnologyProvider value

  • IsGroup: bool value

  • Sid: string value

  • Guid: Guid? value

  • Description: string value

  • Attributes: KeyValuePair<string, string>[] value

  • ExtendedAttributes: KeyValuePair<string, string>[] value

  • Children: string[] value

  • TypeId: int value

Example

GET http://localhost/api/v1/Account/parents

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }

Get Multiple Accounts (POST)

Get Multiple Accounts.

Route

URI

/api/v1/accounts

Method

POST

Result

JSON – IActionResult

Request Payload

MultipleAccountsRequestParameter object:

Property

Type

Mandatory

Description

Keys

string[]

No

 

Options

AccountModelOptions

Yes

 

Example

POST http://localhost/api/v1/accounts Content-Type: application/json  {     "Keys": {},     "Options": {} }

Post T Multiple Accounts (GET)

Post T Multiple Accounts.

Route

URI

/api/v1/accounts

Method

GET

Result

JSON – AccountModel[]

Parameters

None

Response Structure Returns AccountModel[] object containing:

  • ResourceTypeGuid: Guid value

  • SerializedAccountId: string value

  • UriKey: string value

  • DisplayName: string value

  • Provider: TechnologyProvider value

  • IsGroup: bool value

  • Sid: string value

  • Guid: Guid? value

  • Description: string value

  • Attributes: KeyValuePair<string, string>[] value

  • ExtendedAttributes: KeyValuePair<string, string>[] value

  • Children: string[] value

  • TypeId: int value

Example

GET http://localhost/api/v1/accounts

Example Response

{     "ResourceTypeGuid": "123e4567-e89b-12d3-a456-426614174000",     "SerializedAccountId": "sample",     "UriKey": "sample",     "DisplayName": "sample",     "Provider": {},     "IsGroup": true,     "Sid": "sample",     "Guid": "123e4567-e89b-12d3-a456-426614174000",     "Description": "sample",     "Attributes": {},     "ExtendedAttributes": {},     "Children": {},     "TypeId": 1 }