Get 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(required): string
Target Account ID
Query Parameters
-
fields: string
Attributes to be returned in the result. Comma-separated attributes are accepted. Sample value for attributes is "accountName, status, accoutType, resource, applicationInstance"
Response
Supported Media Types
- application/json
200 Response
Successful
Headers
-
ResponseTime: string
Captures the time in milliseconds taken for processing the request.
Root Schema : SingleAccountGetResponseInstance
Type:
Show Source
object-
accountData:
array accountData
-
accountDescription:
string
-
accountType:
string
-
appinstanceId:
string
-
id:
string
-
links:
array links
-
name:
string
-
normalizeData:
array normalizeData
-
policyKey:
string
-
processInstanceKey:
string
-
provisionedBy:
string
-
provisionedByMechanism:
string
-
provisionedOnDate:
string
-
requestId:
string
-
riskSummary:
integer
-
status:
string
-
userId:
string
-
validFromDate:
string
401 Response
Unauthorized
404 Response
Requested entity not found
500 Response
Internal Server Error
Default Response
Unexpected error
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/2
Example of GET Response Body
The following example shows the contents of the response body in JSON format.
{
"links": [
{
"rel": "self",
"href": "http://pseudo.com/iam/governance/selfservice/api/v1/accounts/2"
}
],
"id": "2",
"name": "Test5520190311",
"userId": "82",
"appInstanceId": "1",
"requestId": "",
"fields": [
{
"name": "Status",
"value": "Provisioned"
},
{
"name": "Policy Key",
"value": ""
},
{
"name": "Provisioned By",
"value": "1"
},
{
"name": "Risk Summary",
"value": 0
},
{
"name": "Account Data",
"value": [
{
"name": "UD_ADUSER_TERMINAL_PPATH",
"value": ""
},
{
"name": "UD_ADUSER_DEPARTMENT",
"value": ""
},
{
"name": "UD_ADUSER_MANAGER",
"value": ""
},
{
"name": "UD_ADUSER_NEVER",
"value": false
},
{
"name": "UD_ADUSER_STATE",
"value": ""
},
{
"name": "UD_ADUSER_LNAME",
"value": "TEST55"
},
{
"name": "UD_ADUSER_UPDATE",
"value": "2019-03-11"
},
{
"name": "UD_ADUSER_MNAME",
"value": ""
},
{
"name": "UD_ADUSER_TITLE",
"value": ""
},
{
"name": "UD_ADUSER_SERVER",
"value": "8"
},
{
"name": "UD_ADUSER_MUST",
"value": false
},
{
"name": "UD_ADUSER_CREATE",
"value": "2019-03-11"
},
{
"name": "UD_ADUSER_VERSION",
"value": "0"
},
{
"name": "UD_ADUSER_DATA_LEVEL",
"value": ""
},
{
"name": "UD_ADUSER_ALLOW_LOGIN",
"value": false
},
{
"name": "UD_ADUSER_UPDATEBY",
"value": "1"
},
{
"name": "UD_ADUSER_EMAIL",
"value": ""
},
{
"name": "UD_ADUSER_ZIP",
"value": ""
},
{
"name": "UD_ADUSER_FULLNAME",
"value": "TEST55"
},
{
"name": "UD_ADUSER_USERPRINCIPALNAME",
"value": "TEST55@example.com"
},
{
"name": "UD_ADUSER_REVOKE",
"value": ""
},
{
"name": "UD_ADUSER_HOMEPHONE",
"value": ""
},
{
"name": "UD_ADUSER_COMMONNAME",
"value": "TEST55"
},
{
"name": "UD_ADUSER_POSTOFFICE",
"value": ""
},
{
"name": "UD_ADUSER_PAGER",
"value": ""
},
{
"name": "UD_ADUSER_PASWD_NOT_REQUIRE",
"value": false
},
{
"name": "UD_ADUSER_HOME_DIRECTORY",
"value": ""
},
{
"name": "UD_ADUSER_FAX",
"value": ""
},
{
"name": "UD_ADUSER_STREET",
"value": ""
},
{
"name": "UD_ADUSER_KEY",
"value": "1"
},
{
"name": "UD_ADUSER_LOCKED",
"value": false
},
{
"name": "UD_ADUSER_IPPHONE",
"value": ""
},
{
"name": "UD_ADUSER_OBJECTGUID",
"value": "42806b0faff8d9418ba7221f2f992937"
},
{
"name": "UD_ADUSER_FNAME",
"value": ""
},
{
"name": "UD_ADUSER_CITY",
"value": ""
},
{
"name": "UD_ADUSER_COUNTRY",
"value": ""
},
{
"name": "UD_ADUSER_ORGNAME",
"value": "8~OU=12c,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com"
},
{
"name": "UD_ADUSER_PASSWORD",
"value": ""
},
{
"name": "UD_ADUSER_TELEPHONE",
"value": ""
},
{
"name": "UD_ADUSER_CREATEBY",
"value": "1"
},
{
"name": "UD_ADUSER_UID",
"value": "Test5520190311"
},
{
"name": "UD_ADUSER_NOTE",
"value": "Completed adpADIDCPOPULATEFORMFIELD rule generator for field
'User Id' on Mon Mar 11 15:43:11 PDT 2019,\nCompleted adpADIDCPOPULATEFORMFIELD rule generator
for field 'First Name' on Mon Mar 11 15:43:11 PDT 2019,\nCompleted adpADIDCPOPULATEFORMFIELD
rule generator for field 'Last Name' on Mon Mar 11 15:43:11 PDT 2019,\nCompleted
adpADIDCPOPULATEFORMFIELD rule generator for field 'Middle Name' on Mon Mar 11 15:43:11 PDT
2019,\nCompleted adpADIDCPOPULATEFORMFIELD rule generator for field 'Password' on Mon Mar 11
15:43:11 PDT 2019,\nCompleted adpADIDCPREPOPULATEUSERFULLNAME rule generator for field 'Full
Name' on Mon Mar 11 15:43:11 PDT 2019,\nCompleted adpADIDCPREPOPULATEUSERFULLNAME rule
generator for field 'Common Name' on Mon Mar 11 15:43:11 PDT 2019,\nCompleted
adpADIDCPREPOPULATEUSERPRINCIPALNAME rule generator for field 'User Principal Name' on Mon Mar
11 15:43:11 PDT 2019"
},
{
"name": "UD_ADUSER_COMPANY",
"value": ""
},
{
"name": "UD_ADUSER_EXPIRATIONDATE",
"value": ""
},
{
"name": "UD_ADUSER_OFFICE",
"value": ""
},
{
"name": "UD_ADUSER_MOBILE",
"value": ""
},
{
"name": "UD_ADUSER_REDIRECTION_MAIL_ID",
"value": ""
},
{
"name": "UD_ADUSER_TERMINAL_HDIR",
"value": ""
}
]
},
{
"name": "Provisioned-On Date",
"value": "2019-03-11T22:43:11Z"
},
{
"name": "Process Instance Key",
"value": "201"
},
{
"name": "Valid From Date",
"value": "2019-03-11T22:43:11Z"
},
{
"name": "Account Description",
"value": "Test5520190311"
},
{
"name": "Account Type",
"value": "Primary"
},
{
"name": "Normalize Data",
"value": [
{
"name": "Zip",
"value": [
""
]
},
{
"name": "Office",
"value": [
""
]
},
{
"name": "Terminal Allow Login",
"value": [
false
]
},
{
"name": "Company",
"value": [
""
]
},
{
"name": "Common Name",
"value": [
"TEST55"
]
},
{
"name": "First Name",
"value": [
""
]
},
{
"name": "Full Name",
"value": [
"TEST55"
]
},
{
"name": "Post Office Box",
"value": [
""
]
},
{
"name": "Telephone Number",
"value": [
""
]
},
{
"name": "Middle Name",
"value": [
""
]
},
{
"name": "IP Phone",
"value": [
""
]
},
{
"name": "User Must Change Password At Next Logon",
"value": [
false
]
},
{
"name": "Account Expiration Date",
"value": [
""
]
},
{
"name": "Unique Id",
"value": [
"42806b0faff8d9418ba7221f2f992937"
]
},
{
"name": "Home Phone",
"value": [
""
]
},
{
"name": "Department",
"value": [
""
]
},
{
"name": "Homedirectory",
"value": [
""
]
},
{
"name": "Street",
"value": [
""
]
},
{
"name": "AD Server",
"value": [
"8"
]
},
{
"name": "Password",
"value": [
""
]
},
{
"name": "Account is Locked out",
"value": [
false
]
},
{
"name": "User Id",
"value": [
"Test5520190311"
]
},
{
"name": "Organization Name",
"value": [
"8~OU=12c,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com"
]
},
{
"name": "User Principal Name",
"value": [
"TEST55@example.com"
]
},
{
"name": "Title",
"value": [
""
]
},
{
"name": "City",
"value": [
""
]
},
{
"name": "Terminal Profile Path",
"value": [
""
]
},
{
"name": "UD_ADUSRC",
"value": [
{
"Group Name":
"8~CN=ADGroup_AAT,OU=MainOrg_HNK,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com"
},
{
"Group Name":
"8~CN=ADGroup_AGI,OU=MainOrg_WMM,OU=Vision,DC=adlrg12c,DC=us,DC=pseudo,DC=com"
}
]
},
{
"name": "Mobile",
"value": [
""
]
},
{
"name": "Manager Name",
"value": [
""
]
},
{
"name": "Password Never Expires",
"value": [
false
]
},
{
"name": "Terminal Home Directory",
"value": [
""
]
},
{
"name": "Redirection Mail Id",
"value": [
""
]
},
{
"name": "State",
"value": [
""
]
},
{
"name": "E Mail",
"value": [
""
]
},
{
"name": "Pager",
"value": [
""
]
},
{
"name": "Country",
"value": [
""
]
},
{
"name": "Password Not Required",
"value": [
false
]
},
{
"name": "Last Name",
"value": [
"TEST55"
]
},
{
"name": "Fax",
"value": [
""
]
}
]
}
]
}