Jump to

• Request
• Response
• Examples

Search account based on account id

get

/iam/governance/selfservice/api/v1/accounts/{accountid}

Returns the account details of the specified account id. The attributes that are to be returned can be specified as part of the query parameter named "fields". For example: The URI to get the user name attribute only for a particular account is /accounts/{accountid}?fields=name. The attributes are to be spcified in a Comma-separated list.

Request

Supported Media Types

• application/json

Path Parameters

• accountid: string
  Target Account ID

Query Parameters

• fields(optional): string
  Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "accountName, status, accoutType, resource, applicationInstance"

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : SingleAccountGetResponseInstance

Type: object

Show Source

• accountData(optional): array accountData
• accountDescription(optional): string
• accountType(optional): string
• appinstanceId(optional): string
• id(optional): string
• links(optional): array links
• name(optional): string
• normalizeData(optional): array normalizeData
• policyKey(optional): string
• processInstanceKey(optional): string
• provisionedBy(optional): string
• provisionedByMechanism(optional): string
• provisionedOnDate(optional): string
• requestId(optional): string
• riskSummary(optional): integer
• status(optional): string
• userId(optional): string
• validFromDate(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "appinstanceId":{
            "type":"string"
        },
        "userId":{
            "type":"string"
        },
        "requestId":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "accountType":{
            "type":"string"
        },
        "policyKey":{
            "type":"string"
        },
        "processInstanceKey":{
            "type":"string"
        },
        "provisionedBy":{
            "type":"string"
        },
        "provisionedByMechanism":{
            "type":"string"
        },
        "provisionedOnDate":{
            "type":"string"
        },
        "riskSummary":{
            "type":"integer"
        },
        "accountDescription":{
            "type":"string"
        },
        "validFromDate":{
            "type":"string"
        },
        "normalizeData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/NormalizeData"
            }
        },
        "accountData":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountData"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : accountData

Type: array

Show Source

• [0]: object AccountData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/AccountData"
    }
}

Nested Schema : links

Type: array

Show Source

• [0]: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : normalizeData

Type: array

Show Source

• [0]: object NormalizeData

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/NormalizeData"
    }
}

Nested Schema : AccountData

Type: object

Show Source

• attributes(optional): string

{
    "properties":{
        "attributes":{
            "type":"string"
        }
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

Nested Schema : NormalizeData

Type: object

Show Source

• attributes(optional): string

{
    "properties":{
        "attributes":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Default Response

Unexpected error

Back to Top

Examples

This example retrieves account information for a given account. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/accounts/3

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
  "userId": "1005",
  "appInstanceId": "21",
  "requestId": "",
  "status": "Provisioned",
  "accountType": "Primary",
  "policyKey": "",
  "processInstanceKey": "75",
  "provisionedBy": "1",
  "provisionedByMechanism": "Direct Provision",
  "provisionedOnDate": "2016-03-07",
  "riskSummary": 0,
  "accountDescription": "LOGIN13",
  "validFromDate": "2016-03-07",
  "normalizeData": {
    "account Login": [
      {
        "0": "LOGIN13"
      }
    ],
    "Password": [
      {
        "0": ""
      }
    ],
    "UD_CHILDOBJ": [
      
    ],
    "account_ID": [
      {
        "0": "2222"
      }
    ],
    "accountData": {
      "UD_DIS2365_UPDATEBY": "1",
      "UD_DIS2365_REVOKE": "",
      "UD_DIS2365_CREATE": "2016-03-07",
      "UD_DIS2365_ACCOUNTID": "2222",
      "UD_DIS2365_NOTE": "",
      "UD_DIS2365_CREATEBY": "1",
      "UD_DIS2365_KEY": "1",
      "UD_DIS2365_VERSION": "2",
      "UD_DIS2365_PASSWORD": "",
      "UD_DIS2365_DATA_LEVEL": "",
      "UD_DIS2365_IT": "33",
      "UD_DIS2365_UPDATE": "2016-03-16",
      "UD_DIS2365_ROWVER": "-",
      "UD_DIS2365_LOGIN": "LOGIN13"
    },
    "links": [
      {
        "rel": "self",
        "href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts/3"
      }
    ],
    "id": "3"
  }
}

Back to Top