Skip to content

Commit d379b72

Browse files
add docs for createUser changes
1 parent 5bbde40 commit d379b72

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

docs/api.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -322,10 +322,12 @@ _Note_: You can also access these methods from the `ScannerVariables` class.
322322
- `detailed`: returns additional attributes in summary list of users
323323
- `user_type`: search by user type (e.g. `user` or `api`)
324324
- `request_params`: optionally pass a dictionary of additional query parameters. See [Identity API specification](https://app.swaggerhub.com/apis/Veracode/veracode-identity_api/1.0#/user/getUsersBySearchUsingGET)
325-
- `create_user(email,firstname,lastname,type(opt),username(opt),roles(opt),mfa(opt))`: create a user based on the provided information.
325+
- `create_user(email,firstname,lastname,type(opt),username(opt),roles(opt),mfa(opt),ipRestricted(opt),allowedIpAddresses(opt),samlUser(opt),samlSubject(opt))`: create a user based on the provided information.
326326
- `type`: `"HUMAN"` or `"API"`. Defaults to `"HUMAN"`. If `"API"` specified, must also provide `username`.
327327
- `roles`: list of role names (specified in the Veracode Help Center, for both [human](https://help.veracode.com/go/c_identity_create_human) and [API service account](https://help.veracode.com/go/c_identity_create_api) users). Provide the role names from `get_roles()`.
328328
- `mfa`: set to `TRUE` to require the user to configure multifactor authentication on first sign in.
329+
- `ipRestricted`: set to `TRUE` and provide an array of allowed IP addresses to restrict the IP addresses from which the user can log in. See [Veracode Docs](https://docs.veracode.com/r/admin_ip) for more info.
330+
- `samlUser`: set to `TRUE` and provide a `samlSubject` to require the user to log in via SAML Single Sign-On. See [Veracode Docs](https://docs.veracode.com/r/about_saml#configure-a-user-for-saml-access) for more info.
329331
- `update_user_roles(user_guid, roles)`: update the user identified by `user_guid` with the list of roles passed in `roles`. Because the Identity API does not support adding a single role, the list should be the entire list of existing roles for the user plus whatever new roles. See [veracode-user-bulk-role-assign](https://github.com/tjarrettveracode/veracode-user-bulk-role-assign) for an example.
330332
- `update_user(user_guid,changes)`: update a user based upon the provided information.
331333
- `user_guid`: the unique identifier of the user to be updated.

docs/users.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,12 @@ The following methods call Veracode REST APIs and return JSON.
1616
- `detailed`: returns additional attributes in summary list of users
1717
- `user_type`: search by user type (e.g. `user` or `api`)
1818
- `request_params`: optionally pass a dictionary of additional query parameters. See [Identity API specification](https://app.swaggerhub.com/apis/Veracode/veracode-identity_api/1.0#/user/getUsersBySearchUsingGET)
19-
- `Users().create(email,firstname,lastname,type(opt),username(opt),roles(opt),mfa(opt))`: create a user based on the provided information.
19+
- `Users().create(email,firstname,lastname,type(opt),username(opt),roles(opt),mfa(opt),ipRestricted(opt),allowedIpAddresses(opt),samlUser(opt),samlSubject(opt))`: create a user based on the provided information.
2020
- `type`: `HUMAN` or `API`. Defaults to `HUMAN`. If `API` specified, must also provide `username`.
2121
- `roles`: list of role names (specified in the Veracode Help Center, for both [human](https://help.veracode.com/go/c_identity_create_human) and [API service account](https://help.veracode.com/go/c_identity_create_api) users). Provide the role names from `get_roles()`.
2222
- `mfa`: set to `TRUE` to require the user to configure multifactor authentication on first sign in.
23+
- `ipRestricted`: set to `TRUE` and provide an array of allowed IP addresses to restrict the IP addresses from which the user can log in. See [Veracode Docs](https://docs.veracode.com/r/admin_ip) for more info.
24+
- `samlUser`: set to `TRUE` and provide a `samlSubject` to require the user to log in via SAML Single Sign-On. See [Veracode Docs](https://docs.veracode.com/r/about_saml#configure-a-user-for-saml-access) for more info.
2325
- `Users().update_roles(user_guid, roles)`: update the user identified by `user_guid` with the list of roles passed in `roles`. Because the Identity API does not support adding a single role, the list should be the entire list of existing roles for the user plus whatever new roles. See [veracode-user-bulk-role-assign](https://github.com/tjarrettveracode/veracode-user-bulk-role-assign) for an example.
2426
- `Users().update(user_guid,changes)`: update a user based upon the provided information.
2527
- `user_guid`: the unique identifier of the user to be updated.

0 commit comments

Comments
 (0)