Attributes

List all Attributes for a Group
Admin roles:
  • access_user
  • access_admin
  • reporting_user

Lists all Attributes for a specified Group

SecuritybearerAuth
Request
path Parameters
team_name
required
string

The name of your Team

group_name
required
string

The ASA Group name

query Parameters
offset
string

The UUID of an object used as an offset for pagination

count
integer <int32>

Controls the number of objects listed per page

descending
boolean

If 'true', the most recent results are listed first

prev
boolean

Controls the direction of paging

conflicting
boolean

If true, results only include attributes that conflict with other Group attributes on your Team

Responses
200

OK

get/v1/teams/{team_name}/groups/{group_name}/attributes
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      }
    ]
}
Retrieve a Group Attribute
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Retrieves an Attribute for a Group


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
group_name
required
string
The ASA Group name


 
attribute_id
required
string
The UUID of the Attribute


 
Responses 
200
OK


get/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}
Request samples 
Response samples 
application/json
{
  • "attribute_name": "unix_group_name",
  • "attribute_value": "group_old",
  • "id": "36844d7c-f311-4a42-866c-f32a5a41e213",
  • "managed": false
}
Update a Group Attribute
Admin roles: 
  • access_admin
Updates an Attribute for a Group


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
group_name
required
string
The ASA Group name


 
attribute_id
required
string
The UUID of the Attribute


 
Request Body schema: application/json
required
attribute_name
required
string
Accepted names include unix_group_name, windows_group_name, and unix_gid.


 Enum: "unix_group_name" "windows_group_name" "unix_gid"  
required
unix_group_name (object) or windows_group_name (object) or unix_gid (object)
Accepted values for unix_group_name and windows_group_name are strings of length 0 to 255 and for unix_gid, a number between 100 to 2147483647.


 
One of:
Accepted values for unix_group_name and windows_group_name are strings of length 0 to 255 and for unix_gid, a number between 100 to 2147483647.


  <= 255 characters 
object (unix_group_name)   <= 255 characters 
 
Responses 
204
No Content


put/v1/teams/{team_name}/groups/{group_name}/attributes/{attribute_id}
Request samples 
application/json
{
  • "attribute_name": "unix_group_name",
  • "attribute_value": "new_name"
}
List all Attributes for a User
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Lists all Attributes for a specified user


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
user_name
required
string
The relevant username


 
query Parameters
offset
string
The UUID of an object used as an offset for pagination


 
count
integer <int32> 
Controls the number of objects listed per page


 
descending
boolean
If 'true', the most recent results are listed first


 
prev
boolean
Controls the direction of paging


 
conflicting
boolean
If true, results only include attributes that conflict with other User attributes on your Team


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}/attributes
Request samples 
Response samples 
application/json
{
  • "list": [
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ]
}
Retrieve a User Attribute
Admin roles: 
  • access_user
  • access_admin
  • reporting_user
Retrieves an Attribute for a User


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
user_name
required
string
The relevant username


 
attribute_id
required
string
The UUID of the Attribute


 
Responses 
200
OK


get/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}
Request samples 
Response samples 
application/json
{
  • "attribute_name": "unix_user_name",
  • "attribute_value": "augusta_ada_king",
  • "id": "11faefa1-6b59-4a52-9492-43195cd07385",
  • "managed": true
}
Update a User Attribute
Admin roles: 
  • access_admin
Updates an Attribute for a User


SecuritybearerAuth 
Request 
path Parameters
team_name
required
string
The name of your Team


 
user_name
required
string
The relevant username


 
attribute_id
required
string
The UUID of the Attribute


 
Request Body schema: application/json
required
attribute_name
required
string
The type of attribute


 Enum: "unix_user_name" "unix_uid" "unix_gid" "user_shell" "windows_user_name" "user_home_dir" "gecos_field" "active_directory_identity" "active_directory_passwordless_identity"  
required
unix_user_name (object) or unix_uid (object) or unix_gid (object) or user_shell (object) or windows_user_name (object) or user_home_dir (object) or gecos_field (object) or active_directory_identity (object) or active_directory_passwordless_identity (object)
The value of the attribute. Possible values depend on the attribute_name param: unix_user_name and windows_user_name accept strings of 0 – 255 characters. unix_gid accepts a number from 100 – 2147483647.


 
One of:
The value of the attribute. Possible values depend on the attribute_name param: unix_user_name and windows_user_name accept strings of 0 – 255 characters. unix_gid accepts a number from 100 – 2147483647.


  <= 255 characters 
object (unix_user_name)   <= 255 characters 
 
Responses 
204
No Content


put/v1/teams/{team_name}/users/{user_name}/attributes/{attribute_id}
Request samples 
application/json
{
  • "attribute_name": "unix_user_name",
  • "attribute_value": "ada_lovelace"
}