PUT api/Authorization/AuthorizationMatrix/RoleId/{roleId}

Get Authorization Matrix

Request Information

URI Parameters

Name	Description	Type	Additional information
roleId		integer	Required

Body Parameters

Collection of EsamAuthorizationMatrixDto

Name	Type	Additional information
Authorizations	Authorizations	None.
GroupId	integer	None.
GroupDescription	string	None.
SubgroupId	integer	None.
SubgroupDescription	string	None.
EntityId	ApplicationEntityTypeId	None.
EntityDescription	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "authorizations": {
      "ar": true,
      "al": true,
      "re": true,
      "ue": true,
      "prc": true,
      "poc": true,
      "ru": true,
      "rd": true,
      "nd": true,
      "cr": true,
      "sl": true,
      "rv": true,
      "c": true,
      "r": true,
      "u": true,
      "d": true
    },
    "groupId": 1,
    "groupDescription": "sample string 2",
    "subgroupId": 1,
    "subgroupDescription": "sample string 3",
    "entityId": 0,
    "entityDescription": "sample string 4"
  },
  {
    "authorizations": {
      "ar": true,
      "al": true,
      "re": true,
      "ue": true,
      "prc": true,
      "poc": true,
      "ru": true,
      "rd": true,
      "nd": true,
      "cr": true,
      "sl": true,
      "rv": true,
      "c": true,
      "r": true,
      "u": true,
      "d": true
    },
    "groupId": 1,
    "groupDescription": "sample string 2",
    "subgroupId": 1,
    "subgroupDescription": "sample string 3",
    "entityId": 0,
    "entityDescription": "sample string 4"
  }
]

text/html

Sample:

[{"authorizations":{"ar":true,"al":true,"re":true,"ue":true,"prc":true,"poc":true,"ru":true,"rd":true,"nd":true,"cr":true,"sl":true,"rv":true,"c":true,"r":true,"u":true,"d":true},"groupId":1,"groupDescription":"sample string 2","subgroupId":1,"subgroupDescription":"sample string 3","entityId":0,"entityDescription":"sample string 4"},{"authorizations":{"ar":true,"al":true,"re":true,"ue":true,"prc":true,"poc":true,"ru":true,"rd":true,"nd":true,"cr":true,"sl":true,"rv":true,"c":true,"r":true,"u":true,"d":true},"groupId":1,"groupDescription":"sample string 2","subgroupId":1,"subgroupDescription":"sample string 3","entityId":0,"entityDescription":"sample string 4"}]

application/xml, text/xml

Sample:

<ArrayOfEsamAuthorizationMatrixDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.IdentityModule.Application.Dtos.Dtos.SecurityAgg">
  <EsamAuthorizationMatrixDto>
    <EntityDescription>sample string 4</EntityDescription>
    <EntityId>Default</EntityId>
    <GroupDescription>sample string 2</GroupDescription>
    <GroupId>1</GroupId>
    <SubgroupDescription>sample string 3</SubgroupDescription>
    <SubgroupId>1</SubgroupId>
    <Authorizations>
      <C>true</C>
      <D>true</D>
      <R>true</R>
      <U>true</U>
      <AL>true</AL>
      <AR>true</AR>
      <CR>true</CR>
      <ND>true</ND>
      <POC>true</POC>
      <PRC>true</PRC>
      <RD>true</RD>
      <RE>true</RE>
      <RU>true</RU>
      <RV>true</RV>
      <SL>true</SL>
      <UE>true</UE>
    </Authorizations>
  </EsamAuthorizationMatrixDto>
  <EsamAuthorizationMatrixDto>
    <EntityDescription>sample string 4</EntityDescription>
    <EntityId>Default</EntityId>
    <GroupDescription>sample string 2</GroupDescription>
    <GroupId>1</GroupId>
    <SubgroupDescription>sample string 3</SubgroupDescription>
    <SubgroupId>1</SubgroupId>
    <Authorizations>
      <C>true</C>
      <D>true</D>
      <R>true</R>
      <U>true</U>
      <AL>true</AL>
      <AR>true</AR>
      <CR>true</CR>
      <ND>true</ND>
      <POC>true</POC>
      <PRC>true</PRC>
      <RD>true</RD>
      <RE>true</RE>
      <RU>true</RU>
      <RV>true</RV>
      <SL>true</SL>
      <UE>true</UE>
    </Authorizations>
  </EsamAuthorizationMatrixDto>
</ArrayOfEsamAuthorizationMatrixDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Type	Additional information
Success	boolean	None.
Message	string	None.
Errors	Collection of CustomError	None.
Warnings	Collection of string	None.

Response Formats

application/json, text/json

Sample:

{
  "success": false,
  "message": "sample string 1",
  "errors": [
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    },
    {
      "errorCode": 1,
      "errorMessage": "sample string 2"
    }
  ],
  "warnings": [
    "sample string 1",
    "sample string 2"
  ]
}

text/html

Sample:

{"success":false,"message":"sample string 1","errors":[{"errorCode":1,"errorMessage":"sample string 2"},{"errorCode":1,"errorMessage":"sample string 2"}],"warnings":["sample string 1","sample string 2"]}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TR.eSAM.DistributedServices.WebApi.Base.Results">
  <Errors xmlns:d2p1="http://schemas.datacontract.org/2004/07/TR.eSAM.Infrastructure.Crosscutting.Exceptions">
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
    <d2p1:CustomError>
      <d2p1:ErrorCode>1</d2p1:ErrorCode>
      <d2p1:ErrorMessage>sample string 2</d2p1:ErrorMessage>
    </d2p1:CustomError>
  </Errors>
  <Message>sample string 1</Message>
  <Warnings xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Warnings>
</ApiResult>