Jump to

• Request
• Response

Get user details

get

/scim/{trialname}/2.0/users/{username}

Get user details from the username.

Request

Supported Media Types

• application/json
• text/json
• application/xml
• text/xml
• application/x-www-form-urlencoded

Path Parameters

• trialname(required): string
  Name of the InForm study.
• username(required): string
  username of the user.

Back to Top

Response

Supported Media Types

• application/json
• text/json
• application/xml
• text/xml

200 Response

user details

Body ()

Root Schema : User

Type: object

Show Source

• active: boolean
  Default value is true. Use PATCH with value true to reinstate. All other actions ignore this attribute.
• addresses(required): object addresses
  A physical mailing address for this user.
• displayName(required): string
  Maximum Length: 200

  Pattern: .*

  The name of the User, suitable for display to end users.
• emails(required): array emails
  Email address for the user. Local-part of the email address has a 63 character size limit.
• groups: array groups
  A list of groups to which the user belongs.
• locale(required): locale
• name(required): object FullName
• phoneNumbers: array phoneNumbers
  Contact numbers for the user. The specific format for the contact number is user determined.
• preferredLanguage(required): preferredLanguage
• profileUrl: string
  Maximum Length: 255

  Pattern: .*

  A fully qualified URL pointing to a page representing the user's online picture.
• roles(required): string
  The rights group for the user.
• urn:umt:extension:schema:user(required): object umtUser
• userName(required): string
  Maximum Length: 63

  Pattern: ([A-Z]|[a-z]|[0-9]|-|_|[.]|[@]|)+

  Unique identifier for the User. Each User must include a non-empty userName value. This identifier must also be unique for a given study.
• userType(required): string
  Allowed Values: [ "Site", "Sponsor" ]

  Should be a sponsor or a site user.

{
    "type":"object",
    "required":[
        "userName",
        "name",
        "displayName",
        "userType",
        "preferredLanguage",
        "locale",
        "emails",
        "addresses",
        "roles",
        "urn:umt:extension:schema:user"
    ],
    "properties":{
        "userName":{
            "type":"string",
            "maxLength":"63",
            "pattern":"([A-Z]|[a-z]|[0-9]|-|_|[.]|[@]|)+",
            "description":"Unique identifier for the User. Each User must include a non-empty userName value. This identifier must also be unique for a given study."
        },
        "name":{
            "$ref":"#/definitions/FullName"
        },
        "displayName":{
            "type":"string",
            "maxLength":"200",
            "pattern":".*",
            "description":"The name of the User, suitable for display to end users."
        },
        "profileUrl":{
            "type":"string",
            "maxLength":"255",
            "pattern":".*",
            "description":"A fully qualified URL pointing to a page representing the user's online picture."
        },
        "userType":{
            "type":"string",
            "description":"Should be a sponsor or a site user.",
            "enum":[
                "Site",
                "Sponsor"
            ]
        },
        "preferredLanguage":{
            "allOf":[
                {
                    "$ref":"#/definitions/locale"
                },
                {
                    "description":"preferred study locale for the user."
                }
            ]
        },
        "locale":{
            "allOf":[
                {
                    "$ref":"#/definitions/locale"
                },
                {
                    "description":"product locale for the user."
                }
            ]
        },
        "active":{
            "type":"boolean",
            "description":"Default value is true. Use PATCH with value true to reinstate. All other actions ignore this attribute."
        },
        "emails":{
            "type":"array",
            "description":"Email address for the user. Local-part of the email address has a 63 character size limit.",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/email"
                    }
                ]
            }
        },
        "phoneNumbers":{
            "type":"array",
            "description":"Contact numbers for the user. The specific format for the contact number is user determined.",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/ContactNumber"
                    }
                ]
            }
        },
        "addresses":{
            "type":"object",
            "description":"A physical mailing address for this user.",
            "allOf":[
                {
                    "$ref":"#/definitions/address"
                }
            ]
        },
        "groups":{
            "type":"array",
            "description":"A list of groups to which the user belongs.",
            "items":{
                "allOf":[
                    {
                        "$ref":"#/definitions/groups"
                    }
                ]
            }
        },
        "roles":{
            "type":"string",
            "description":"The rights group for the user."
        },
        "urn:umt:extension:schema:user":{
            "$ref":"#/definitions/umtUser"
        }
    }
}

Nested Schema : addresses

Type: object

A physical mailing address for this user.

Match All

Show Source

• object address

{
    "type":"object",
    "description":"A physical mailing address for this user.",
    "allOf":[
        {
            "$ref":"#/definitions/address"
        }
    ]
}

Nested Schema : emails

Type: array

Email address for the user. Local-part of the email address has a 63 character size limit.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Email address for the user. Local-part of the email address has a 63 character size limit.",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/email"
            }
        ]
    }
}

Nested Schema : groups

Type: array

A list of groups to which the user belongs.

Show Source

• Array of: items

{
    "type":"array",
    "description":"A list of groups to which the user belongs.",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/groups"
            }
        ]
    }
}

Nested Schema : locale

Match All

Show Source

• string
  Allowed Values: [ "English (United States)", "Japanese (Japan)" ]
• product locale for the user.

{
    "allOf":[
        {
            "$ref":"#/definitions/locale"
        },
        {
            "description":"product locale for the user."
        }
    ]
}

Nested Schema : FullName

Type: object

Show Source

• familyName(required): string
  Maximum Length: 127

  Pattern: ([^~`!@#$%^&*()_\\+=\\{\\}\\[\\]\\|\\\\\\:\\;\"\'\\<\\,\\>\\.\\?\\/0-9\\t])+

  The family name of the user, or last name in most Western languages.
• formatted: string
  Maximum Length: 200

  Pattern: .*

  Description for the user.
• givenName(required): string
  Maximum Length: 127

  Pattern: ([^~`!@#$%^&*()_\\+=\\{\\}\\[\\]\\|\\\\\\:\\;\"\'\\<\\,\\>\\.\\?\\/0-9\\t])+

  The given name of the user, or first name in most Western languages.
• honorificPrefix: string
  Maximum Length: 127

  Pattern: ([A-Z]|[a-z]| |_|[.]|[,]|)*

  The honorific prefix or prefixes of the user, or title in most Western languages (for example, 'Ms.').

{
    "type":"object",
    "required":[
        "familyName",
        "givenName"
    ],
    "properties":{
        "familyName":{
            "type":"string",
            "maxLength":"127",
            "pattern":"([^~`!@#$%^&*()_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\\\\\:\\\\;\\\"\\'\\\\<\\\\,\\\\>\\\\.\\\\?\\\\/0-9\\\\t])+",
            "description":"The family name of the user, or last name in most Western languages."
        },
        "givenName":{
            "type":"string",
            "maxLength":"127",
            "pattern":"([^~`!@#$%^&*()_\\\\+=\\\\{\\\\}\\\\[\\\\]\\\\|\\\\\\\\\\\\:\\\\;\\\"\\'\\\\<\\\\,\\\\>\\\\.\\\\?\\\\/0-9\\\\t])+",
            "description":"The given name of the user, or first name in most Western languages."
        },
        "honorificPrefix":{
            "type":"string",
            "maxLength":"127",
            "pattern":"([A-Z]|[a-z]| |_|[.]|[,]|)*",
            "description":"The honorific prefix or prefixes of the user, or title in most Western languages (for example, 'Ms.')."
        },
        "formatted":{
            "type":"string",
            "maxLength":"200",
            "pattern":".*",
            "description":"Description for the user."
        }
    }
}

Nested Schema : phoneNumbers

Type: array

Contact numbers for the user. The specific format for the contact number is user determined.

Show Source

• Array of: items

{
    "type":"array",
    "description":"Contact numbers for the user. The specific format for the contact number is user determined.",
    "items":{
        "allOf":[
            {
                "$ref":"#/definitions/ContactNumber"
            }
        ]
    }
}

Nested Schema : preferredLanguage

Match All

Show Source

• string
  Allowed Values: [ "English (United States)", "Japanese (Japan)" ]
• preferred study locale for the user.

{
    "allOf":[
        {
            "$ref":"#/definitions/locale"
        },
        {
            "description":"preferred study locale for the user."
        }
    ]
}

Nested Schema : umtUser

Type: object

Show Source

• DateFormat(required): DateFormat
• DoTechnicalAssessment: boolean
  True if the user assessment needs to be enabled. Defaults to false.
• Reason(required): string
  Maximum Length: 255

  Reason for the change.
• SiteMnemonic(required): array SiteMnemonic
  Sites the user is assigned to. Use the keyword ALL to include all the sites. This field is required when re-activating the user.
• TrainedDate: string(date dd-MMM-yyyy)
  Date the user was trained on.
• TrainingStatus: string
  Allowed Values: [ "TRAINED", "ENROLLED", "NOT TRAINED" ]

  Determines if the user should be marked as trained or not.

{
    "type":"object",
    "required":[
        "SiteMnemonic",
        "DateFormat",
        "Reason"
    ],
    "properties":{
        "SiteMnemonic":{
            "type":"array",
            "description":"Sites the user is assigned to. Use the keyword ALL to include all the sites. This field is required when re-activating the user.",
            "items":{
                "type":"string"
            }
        },
        "DateFormat":{
            "allOf":[
                {
                    "$ref":"#/definitions/DateFormat"
                }
            ]
        },
        "TrainingStatus":{
            "type":"string",
            "description":"Determines if the user should be marked as trained or not.",
            "enum":[
                "TRAINED",
                "ENROLLED",
                "NOT TRAINED"
            ]
        },
        "TrainedDate":{
            "type":"string",
            "description":"Date the user was trained on.",
            "format":"date dd-MMM-yyyy"
        },
        "DoTechnicalAssessment":{
            "type":"boolean",
            "description":"True if the user assessment needs to be enabled. Defaults to false."
        },
        "Reason":{
            "type":"string",
            "maxLength":"255",
            "description":"Reason for the change."
        }
    }
}

Nested Schema : address

Type: object

Show Source

• country(required): string
  Maximum Length: 255

  Pattern: ([a-zA-Z0-9]| | )+

  The country name component.
• formatted: string
  Maximum Length: 255

  Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

  Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application.
• locality: string
  Maximum Length: 255

  Pattern: ([a-zA-Z0-9]| | )+

  The city or locality component of the address.
• postalCode: string
  Maximum Length: 16

  The zip code or postal code component.
• region: string
  Maximum Length: 255

  Pattern: ([A-Z]|[a-z]| | )*

  The state or region component.
• streetAddress(required): string
  Maximum Length: 255

  Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

  The full street address component, which may include building number, street name, and P.O. box.

{
    "type":"object",
    "required":[
        "streetAddress",
        "country"
    ],
    "properties":{
        "streetAddress":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"The full street address component, which may include building number, street name, and P.O. box."
        },
        "formatted":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+",
            "description":"Any additional line for the address after 'streetAddress'. This is labeled as 'Address2' in the Oracle User Management Tool application."
        },
        "locality":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The city or locality component of the address."
        },
        "region":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([A-Z]|[a-z]| | )*",
            "description":"The state or region component."
        },
        "postalCode":{
            "type":"string",
            "maxLength":"16",
            "description":"The zip code or postal code component."
        },
        "country":{
            "type":"string",
            "maxLength":"255",
            "pattern":"([a-zA-Z0-9]| | )+",
            "description":"The country name component."
        }
    }
}

Nested Schema : items

Match All

Show Source

• object email

{
    "allOf":[
        {
            "$ref":"#/definitions/email"
        }
    ]
}

Nested Schema : email

Type: object

Show Source

• value(required): string
  Maximum Length: 255

  Pattern: ^['a-zA-Z0-9_-]+(?:\.['a-zA-Z0-9_-]+)*@((?!-)[A-Za-z0-9-]*[A-Za-z0-9])+(\.(?!-)[A-Za-z0-9-]*[A-Za-z0-9])*(\.[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$

{
    "type":"object",
    "required":[
        "value"
    ],
    "properties":{
        "value":{
            "type":"string",
            "maxLength":"255",
            "pattern":"^['a-zA-Z0-9_-]+(?:\\.['a-zA-Z0-9_-]+)*@((?!-)[A-Za-z0-9-]*[A-Za-z0-9])+(\\.(?!-)[A-Za-z0-9-]*[A-Za-z0-9])*(\\.[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$"
        }
    }
}

Nested Schema : items

Match All

Show Source

• object groups

{
    "allOf":[
        {
            "$ref":"#/definitions/groups"
        }
    ]
}

Nested Schema : groups

Type: object

Show Source

• type(required): string
  Allowed Values: [ "query", "signature", "manageruser", "reportgroup" ]
• value(required): string
  The identifier of the User's group.

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "query",
                "signature",
                "manageruser",
                "reportgroup"
            ]
        },
        "value":{
            "type":"string",
            "description":"The identifier of the User's group."
        }
    }
}

Nested Schema : items

Match All

Show Source

• object ContactNumber

{
    "allOf":[
        {
            "$ref":"#/definitions/ContactNumber"
        }
    ]
}

Nested Schema : ContactNumber

Type: object

Show Source

• type(required): string
  Allowed Values: [ "primary", "fax", "alternate", "pager" ]
• value(required): string
  Maximum Length: 25

  Pattern: ([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+

{
    "type":"object",
    "required":[
        "type",
        "value"
    ],
    "properties":{
        "type":{
            "type":"string",
            "enum":[
                "primary",
                "fax",
                "alternate",
                "pager"
            ]
        },
        "value":{
            "type":"string",
            "maxLength":"25",
            "pattern":"([A-Z]|[a-z]|[0-9]|[,]|-|_|[.]| |)+"
        }
    }
}

Nested Schema : DateFormat

Match All

Show Source

• string
  Allowed Values: [ "Day / Month / Year", "Month / Day / Year", "Year / Month / Day" ]

  DateFormat to be used.

{
    "allOf":[
        {
            "$ref":"#/definitions/DateFormat"
        }
    ]
}

Nested Schema : SiteMnemonic

Type: array

Sites the user is assigned to. Use the keyword ALL to include all the sites. This field is required when re-activating the user.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Sites the user is assigned to. Use the keyword ALL to include all the sites. This field is required when re-activating the user.",
    "items":{
        "type":"string"
    }
}

401 Response

Unauthorized. An invalid token or study name was provided

Body ()

Root Schema : schema

Type: object

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

• Message: string
  Default Value: Error messages defined in the model.

  • Unauthorized - An invalid token or study name was provided.
  • Username not found - username is incorrect.
  • Unknown error - Internal processing error. Please contact support.

{
    "type":"object",
    "properties":{
        "Message":{
            "type":"string",
            "description":"<ul>\n<li><i>Unauthorized</i> - An invalid token or study name was provided.</li>\n<li><i>Username not found</i> - username is incorrect.</li>\n<li><i>Unknown error</i> -  Internal processing error. Please contact support.</li>\n</ul>\n",
            "default":"Error messages defined in the model."
        }
    }
}

Back to Top