Jump to

• Request
• Response

Get details about authenticated user

get

/system/api/v1/me

Get the details about authenticated user from Identity Provider(IdP). ## Authorization Authenticated user can request the details from IdP.

Request

Supported Media Types

• application/json

Query Parameters

• customAttributes(optional): String
  The comma-seperated and case-insensitive strings that specifies the names of IDCS custom attributes that should be returned in the UserInfo response. By default, a response will contain only few predefined User's attributes. If a request specifies this query parameter, the response includes the attributes that this query parameter specifies along with the predefined User's attributes. Maximum number of custom attributes allowed in the query parameters is 20.
• includeGroupMembership(optional): boolean
  A boolean query parameter, which when set to true, include all the IDCS groups(Group's DisplayName and GUID) the user is part of, in the response.
• includeIDCSAppRoles(optional): boolean
  A boolean query parameter, which when set to true, includes all the service specific IDCS Application roles the user is assigned to, in the response.
• includeRealmUserGUID(optional): boolean
  A boolean query parameter, which when set to true, include user's GUID from Realm in the response.

Back to Top

Response

Supported Media Types

• application/json

200 Response

OK

Body ()

Root Schema : UserInfo

Type: object

Self-Management details.

Show Source

• customAttributes(optional): object customAttributes
  Object containing specified custom attributes and their values.
• email: string
  User's primary email address.

  Example: [e-mail]
• firstName(optional): string
  User's first name.

  Example: Joe
• idcsappRoles(optional): array idcsappRoles
  Array of IDCS Application roles, the user is part of.
• lastName: string
  User's last name.

  Example: Janesen
• links: array links
  Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.
• locale(optional): string
  User's locale.

  Example: en
• membershipGroupsList(optional): array membershipGroupsList
  Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID.
• middleName(optional): string
  User's middle name.

  Example: Jane
• realmUserGUID(optional): string
  User's GUID from realm

  Example: 26e1a1b236b8415e97f1b44a60639ba8
• timezone(optional): string
  User's timezone.

  Example: America/Los_Angeles
• userName: string
  User name.

  Example: [e-mail]

{
    "type":"object",
    "properties":{
        "realmUserGUID":{
            "type":"string",
            "example":"26e1a1b236b8415e97f1b44a60639ba8",
            "description":"User's GUID from realm"
        },
        "userName":{
            "type":"string",
            "example":"[e-mail]",
            "description":"User name."
        },
        "firstName":{
            "type":"string",
            "example":"Joe",
            "description":"User's first name."
        },
        "middleName":{
            "type":"string",
            "example":"Jane",
            "description":"User's middle name."
        },
        "lastName":{
            "type":"string",
            "example":"Janesen",
            "description":"User's last name."
        },
        "email":{
            "type":"string",
            "example":"[e-mail]",
            "description":"User's primary email address."
        },
        "locale":{
            "type":"string",
            "example":"en",
            "description":"User's locale."
        },
        "timezone":{
            "type":"string",
            "example":"America/Los_Angeles",
            "description":"User's timezone."
        },
        "links":{
            "type":"array",
            "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "customAttributes":{
            "type":"object",
            "description":"Object containing specified custom attributes and their values."
        },
        "membershipGroupsList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Group"
            },
            "description":"Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID."
        },
        "idcsappRoles":{
            "type":"array",
            "items":{
                "type":"string"
            },
            "description":"Array of IDCS Application roles, the user is part of."
        }
    },
    "description":"Self-Management details.",
    "required":[
        "userName",
        "lastName",
        "email",
        "links"
    ]
}

Nested Schema : customAttributes

Type: object

Object containing specified custom attributes and their values.

Nested Schema : idcsappRoles

Type: array

Array of IDCS Application roles, the user is part of.

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    },
    "description":"Array of IDCS Application roles, the user is part of."
}

Nested Schema : links

Type: array

Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.

Show Source

• Array of: object Link
  REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

{
    "type":"array",
    "description":"Link to related resources and actions or actions on this resource. Must include at least a 'self' link that contains a link to the canonical representation of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : membershipGroupsList

Type: array

Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID.

Show Source

• Array of: object Group
  IDCS group, the user is part of.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Group"
    },
    "description":"Array of IDCS groups the user is part of. Each group entry contains group's DisplayName and it's IDCS ID."
}

Nested Schema : Link

Type: object

REST link and related meta data. If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure.

Show Source

• href(optional): string
  The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`.
• mediaType(optional): string
  Link target. Media type, as defined by RFC 2046, describing the link target.
• method(optional): string
  Link target HTTP method. HTTP method for requesting the target of the link. * `none` - Indicates no valid HTTP method * `OPTIONS` - HTTP OPTIONS * `HEAD` - HTTP HEAD * `GET` - HTTP GET * `POST` - HTTP POST * `PUT` - HTTP PUT * `PATCH` - HTTP PATCH * `DELETE` - HTTP DELETE
• profile(optional): string
  Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource.
• rel(optional): string
  Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details.
• templated(optional): boolean
  Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present.

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string",
            "description":"Link relation. Name of the link relation that, in addition to the type property, can be used to retrieve link details."
        },
        "href":{
            "type":"string",
            "description":"The target resource URI. URI *RFC3986* or URI Template *RFC6570*. If the value is set to URI Template, then the `templated` property must be set to `true`."
        },
        "templated":{
            "type":"boolean",
            "description":"Link href template flag. Boolean flag that specifies the `href` property is a URI or URI Template. The property can be assumed to be `false` if the property is not present."
        },
        "mediaType":{
            "type":"string",
            "description":"Link target. Media type, as defined by RFC 2046, describing the link target."
        },
        "method":{
            "type":"string",
            "description":"Link target HTTP method. HTTP method for requesting the target of the link.  *  `none` - Indicates no valid HTTP method *  `OPTIONS` - HTTP OPTIONS *  `HEAD` - HTTP HEAD *  `GET` - HTTP GET *  `POST` - HTTP POST *  `PUT` - HTTP PUT *  `PATCH` - HTTP PATCH *  `DELETE` - HTTP DELETE"
        },
        "profile":{
            "type":"string",
            "description":"Link meta data location. Link to the metadata of the resource, such as JSON-schema, that describes the resource expected when dereferencing the target resource."
        }
    },
    "description":"REST link and related meta data.  If responses provide links (e.g. a `self` link to the resource itself) the links provided will include one or more of the properties defined on this link structure."
}

Nested Schema : Group

Type: object

IDCS group, the user is part of.

Show Source

• DisplayName: string
  IDCS group's displayName.
• ID: string
  IDCS group's ID.

{
    "type":"object",
    "properties":{
        "DisplayName":{
            "type":"string",
            "description":"IDCS group's displayName."
        },
        "ID":{
            "type":"string",
            "description":"IDCS group's ID."
        }
    },
    "required":[
        "DisplayName",
        "ID"
    ],
    "description":"IDCS group, the user is part of."
}

304 Response

Not Modified

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

400 Response

Bad Request

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

404 Response

Not Found

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : ExceptionDetail

Type: object

Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

Show Source

• detail(optional): string
  Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details.
• instance(optional): string
  URI to the link that provides more detail about the error.
• o:errorCode(optional): string
  Application error code, which is different from HTTP error code.
• o:errorDetails(optional): array o:errorDetails
  Multiple errors can be organized in a hierarchical structure.
• o:errorPath(optional): string
  XPath or JSON path to indicate where the error occurs.
• status(optional): integer(int32)
  HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`.
• title(optional): string
  Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization.
• type(optional): string
  Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Absolute URI that identifies the problem type. When this URI dereferenced, it **should** provide a human-readable summary of the problem, for example, as a HTML page."
        },
        "title":{
            "type":"string",
            "description":"Short, human-readable summary of the problem. The summary **should not** change for subsequent occurrences of the problem, except for purposes of localization."
        },
        "status":{
            "type":"integer",
            "format":"int32",
            "description":"HTTP status code. The corresponding HTTP status code for the exception. For exception that includes a resource does not exist would have a HTTP status of `404`."
        },
        "detail":{
            "type":"string",
            "description":"Description specific to this occurrence of the problem. The human readable, potentially multi-line details describing the problem in more details."
        },
        "instance":{
            "type":"string",
            "description":"URI to the link that provides more detail about the error."
        },
        "o:errorCode":{
            "type":"string",
            "description":"Application error code, which is different from HTTP error code."
        },
        "o:errorPath":{
            "type":"string",
            "description":"XPath or JSON path to indicate where the error occurs."
        },
        "o:errorDetails":{
            "type":"array",
            "description":"Multiple errors can be organized in a hierarchical structure.",
            "items":{
                "$ref":"#/definitions/ExceptionDetail"
            }
        }
    },
    "description":"Error details for a REST request.  In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail."
}

Nested Schema : o:errorDetails

Type: array

Multiple errors can be organized in a hierarchical structure.

Show Source

• Array of: object ExceptionDetail
  Error details for a REST request. In addition to HTTP error code and error messages, it is often desirable to provide additional information to the client when a request fails. In such these cases, the additional information must be included in the error response body. The additional information is optional, but if provided, it will be in the form of exception detail.

{
    "type":"array",
    "description":"Multiple errors can be organized in a hierarchical structure.",
    "items":{
        "$ref":"#/definitions/ExceptionDetail"
    }
}

Back to Top