Jump to

• Request
• Response

Terminate or reinstate a user

patch

/scim/{trialname}/2.0/users

Terminates or reinstates a user.

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.

Body ()

Root Schema : schema

Match All

Show Source

• object UserPatch

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

Nested Schema : UserPatch

Type: object

Show Source

• active(required): boolean
  Use value true to re-instate, false to terminate.
• urn:umt:extension:schema:user(required): urn:umt:extension:schema:user
• userName: string
  Unique identifier for the User. Each User must include a non-empty userName value. This identifier must also be unique for a given study.

{
    "type":"object",
    "required":[
        "username",
        "active",
        "urn:umt:extension:schema:user"
    ],
    "properties":{
        "active":{
            "type":"boolean",
            "description":"Use value true to re-instate, false to terminate."
        },
        "userName":{
            "type":"string",
            "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."
        },
        "urn:umt:extension:schema:user":{
            "allOf":[
                {
                    "$ref":"#/definitions/UserPatchAttr"
                }
            ]
        }
    }
}

Nested Schema : urn:umt:extension:schema:user

Match All

Show Source

• object UserPatchAttr

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

Nested Schema : UserPatchAttr

Type: object

Show Source

• 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.

{
    "type":"object",
    "required":[
        "SiteMnemonic"
    ],
    "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"
            }
        }
    }
}

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"
    }
}

Back to Top

Response

Supported Media Types

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

200 Response

OK

Body ()

Root Schema : schema

Type: object

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

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

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

{
    "type":"object",
    "properties":{
        "error":{
            "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>Invalid Site</i> -  Invalid site number provided.</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